Skip to content
This repository has been archived by the owner on Feb 14, 2025. It is now read-only.

Multiline tagging for parser #19

Open
gaffarelj opened this issue Dec 30, 2021 · 2 comments
Open

Multiline tagging for parser #19

gaffarelj opened this issue Dec 30, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@gaffarelj
Copy link
Member

Currently, the following have to be added at the end of lines in the docstrings of tudat-multidoc:

  • # [py] if the line is only for tudatpy.
  • # [cpp] if the line is only for tudat.

This makes setting up examples particularly cumbersome, as these have to be added at each line of the examples in the docstrings, making their source messier (see here as an example).

@FilippoOggionni and I discussed the possibility of having a different type of keyword that could then englobe multiple lines. For instance, how about having /* [py] and [py] */ respectively open and close a set of lines that are to be parsed as if they all ended in # [py]?

@gaffarelj gaffarelj added the enhancement New feature or request label Dec 30, 2021
@gaffarelj gaffarelj self-assigned this Dec 30, 2021
@gaffarelj
Copy link
Member Author

@ggarrett13 I also assign this to you, as you are probably best placed to deal with this.

As mentioned, this is only for our own life's improvement and is thus of very low priority.

I may myself dig into it if I end up finding time for it.

@geoffreygarrett
Copy link
Member

Hi, your suggestion for multiline tagging sounds straightforward to implement. I'll look into it.

@gaffarelj gaffarelj changed the title Low priority request for docstrings parser Multiline tagging for parser Jul 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants