Properly dedent doc strings after parsing in the proc-macro #1899
Conversation
This file contains 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
mhammond
requested changes
Dec 13, 2023
| @@ -36,7 +36,13 @@ | |||
| assert AssociatedErrorTest.Test2.__doc__ == "<docstring-associated-error-variant-2>" | |||
|
|
|||
| # Test objects | |||
| assert ObjectTest.__doc__ == "<docstring-object>" | |||
| expected_object_doc = """ | |||
There was a problem hiding this comment.
it wasn't immediately clear to me why this was expected. Can you please see if a test in fixtures/procmacros isn't too difficult, and there you can test the string without the language-specific indents added by languages, and also comment about exactly why the value is what it is (ie, describe in words the intent of the dedent). Ideally here you'd also explain the same (but in this case, IIUC, Python has added an indent to match the indent of the object definition in the generated .py code?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1884
I changed both docstring tests. We can unify those tests in a followup.