Inspect class doc output#17685
Open
jcapriot wants to merge 14 commits into
Open
Conversation
for more information, see https://pre-commit.ci
use cleandoc logic to determin dedent in docstring
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
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.
Fixes #16543
Outputs the class docstring in the
InspectionStubGenerator, dependent upon the --include-doc setting.I've attempted to add tests to verify it, but it looks like the stubgen pytests are skipped? So i've also attempted to add it as a setting in the github action testing script, Obviously if you all know more about the stubgen tests and where best to add it, let me know. In the meantime I've tested this locally and it seems to produce the expected behavoir. It now inclused docs and looks to put them at the correct indent level.