Remove leading newlines from docstrings #274
Open
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
If pybind11-stubgen is run on a normal python docstring it will convert this ```py """ This is a docstring. """ ``` To this ```py """ This is a docstring. """ ``` The leading newline is interpreted as part of the docstring and pybind11-stubgen will add another newline as part of its formatting. Stripping these leading newlines should have no effect in docstrings defined using pybind11 unless the user adds a leading newline for some reason.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
If pybind11-stubgen is run on a normal python docstring it will convert this
To this
The leading newline is interpreted as part of the docstring and pybind11-stubgen will add another newline as part of its formatting.
Stripping these leading newlines should have no effect in docstrings defined using pybind11 unless the user adds a leading newline for some reason.