Skip to content

new segment type: inline #3

Description

@charlesdaniels

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions