Deprecate is_module parameter in get_docstring #82192
Open
+9
−3
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
Couldn't add it in initial commit due to not knowing my pull request's URL.
ansibot
added
needs_triage
ansibot
removed
the
needs_revision
s-hertel
removed
the
needs_triage
s-hertel
reviewed
Nov 14, 2023
Co-Authored-By: Sloane Hertel <19572925+s-hertel@users.noreply.github.com> Co-Authored-By: Matt Martz <matt@sivel.net>
ansibot
added
the
stale_ci
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.
SUMMARY
A 3-year-old TODO in the source code said to deprecate
is_moduleas a parameter toget_docstring. From reading the code I inferred that the preferred alternative would be to pass inplugin_type='module'instead.