Avoid removing newlines between docstring headers and rST blocks #11609
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
charliermarsh
added
bug
|
\cc @harupy |
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| D412 | 93 | 0 | 93 | 0 | 0 |
Linter (preview)
ℹ️ ecosystem check detected linter changes. (+0 -93 violations, +0 -0 fixes in 2 projects; 48 projects unchanged)
bokeh/bokeh (+0 -92 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview --select ALL
- src/bokeh/command/subcommands/file_output.py:100:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/command/subcommands/file_output.py:70:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/command/util.py:193:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/json_encoder.py:103:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/core/property/any.py:60:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/color.py:100:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/descriptors.py:263:9: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/core/property/either.py:57:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/numeric.py:136:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/numeric.py:181:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/numeric.py:214:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/numeric.py:255:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/primitive.py:131:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/primitive.py:166:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/primitive.py:212:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/primitive.py:77:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/property/string.py:59:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/core/query.py:78:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/document/models.py:123:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/model/model.py:464:9: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/model/util.py:154:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/models/plots.py:157:9: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/models/sources.py:438:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/models/sources.py:493:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/models/tools.py:616:5: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/palettes.py:1696:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1725:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1754:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1783:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1812:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1845:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1874:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/palettes.py:1906:5: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/_figure.py:309:9: D412 [*] No blank lines allowed between a section header and its content ("Example") - src/bokeh/plotting/glyph_api.py:1005:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:115:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:131:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:147:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:164:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:181:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:198:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:215:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:232:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:249:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:266:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:283:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:300:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:316:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") - src/bokeh/plotting/glyph_api.py:333:1: D412 [*] No blank lines allowed between a section header and its content ("Examples") ... 43 additional changes omitted for project
latchbio/latch (+0 -1 violations, +0 -0 fixes)
ruff check --no-cache --exit-zero --ignore RUF9 --output-format concise --preview
- latch/types/metadata.py:463:5: D412 [*] No blank lines allowed between a section header and its content ("Example")
Changes by rule (1 rules affected)
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| D412 | 93 | 0 | 93 | 0 | 0 |
|
@charliermarsh thanks for fixing this! |
MichaReiser
approved these changes
May 30, 2024
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.
Given:
Removing the newline after the
Example:header breaks Sphinx rendering.See: #11577