Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new segment type: inline #3

Open
charlesdaniels opened this issue Nov 29, 2017 · 0 comments
Open

new segment type: inline #3

charlesdaniels opened this issue Nov 29, 2017 · 0 comments

Comments

@charlesdaniels
Copy link
Owner

Example:

... some code ...
# .INLINE

Some documentation which is directly pertinent to this code, but which also needs to wind up in the generated reST
# .ENDOC
... more code ...

The trouble lies in how exactly to handle .INLINE type blocks, since if we wanted to just append the text to the top-level .SCRIPTDOC segment, we would have to buffer the .SCRIPTDOC segment in memory until EOF is reached.

Alternatively, .INLINE segments could be accumulated, concatenated, and added to the output after EOF is reached, and thus displayed under a section header along the lines of "Further Notes".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant