Use single-line comment characters for docstrings #1169
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pnbabu
reviewed
Feb 19, 2025
pnbabu
approved these changes
Feb 21, 2025
Contributor
pnbabu
left a comment
pnbabu
left a comment
There was a problem hiding this comment.
Looks good to me! I am fine merging this after the CI turns green.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is no need to use a special
"""token for model docstrings; NESTML already processes a series of single-line comments preceding a model definition as a "pre comment" and belonging to the model AST node.This change makes docstring comments more consistent particularly when using the
includestatement (#1121).