Don't use a dash if there's no description to introduce #12035
Merged
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
picnixz
reviewed
Mar 2, 2024
08860b5
to
d0fb5d6
Compare
picnixz
approved these changes
Mar 2, 2024
d0fb5d6
to
00af111
Compare
|
Thank you! I don't think a changelog entry is needed, but feel free to create one in a separate PR if you want! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: In parameter lists, an en-dash is added even if there's no description following it.
Feature or Bugfix
Purpose
The coverage.py docs currently have this:
My docstrings aren't structured in a way to extract parameters, so there are no descriptions for them. But there's a dash leading to nothing.
With this fix, the same parameter list looks like this, which makes more sense:
