tudat-team / tudat-multidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Multiline tagging for parser

gaffarelj opened this issue · comments

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]?

@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.

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