GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. by JulienPalard · Pull Request #23802 · python/cpython

Conversation

@JulienPalard

@JulienPalard JulienPalard commented Dec 16, 2020 •
edited by bedevere-bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

This is to avoid things like: #23800

https://bugs.python.org/issue42238

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Dec 16, 2020
@bedevere-bot bedevere-bot added the awaiting core review label Dec 16, 2020
@JulienPalard JulienPalard added skip news and removed awaiting core review labels Dec 16, 2020
@JulienPalard JulienPalard mentioned this pull request Dec 16, 2020
Fix reStructuredText syntax in NEWS.d. #23800
Merged
@JulienPalard
Check Misc/NEWS.d/next/ for reStructuredText issues.
bc2a7d7
@JulienPalard
JulienPalard force-pushed the doc-check branch from 76e000a to bc2a7d7 Compare December 16, 2020 15:53
Fidget-Spinner
Fidget-Spinner reviewed Dec 17, 2020
View reviewed changes
Comment thread Doc/tools/rstlint.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/tools/rstlint.py Outdated
line = "\n"
else:
in_multiline_comment = False
if line.startswith(".. "):

@Fidget-Spinner Fidget-Spinner Dec 17, 2020

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry if I'm misinterpreting something here, but wouldn't this remove directives like .. describes:: or .. class:: too? Or is that intentional?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@JulienPalard JulienPalard Dec 17, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're understanding it correctly, it removes a bit too much. But the documentation tells comments are Every explicit markup block which isn’t a valid markup construct.

an explicit markup is:

An explicit markup block begins with a line starting with .. followed by whitespace and is terminated by the next paragraph at the same level of indentation.

According to the ref, explicite markup are

used for footnotes, citations, hyperlink targets, directives, substitution definitions, and comments

in directives there's potentially a lot, as it's possible to add new directives, like versionchanged in our doc.

So we have like three choices:

  • Keep it simple and introduce some false negatives (current version)
  • Do it right with no false positives and no false negative, it's probably doable as we have the exhaustive list of directives already hardcoded in rstlint.py
  • Keep it simple, the other way around, and introduce some false positives.

I'm really not in favor of false positives: it's a burden for contributors. False negatives are OK though: if an rst error is introduced it'll still fixable later.

I'll try myself at the "do it right version" today to see if it's worth it.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@JulienPalard JulienPalard Dec 17, 2020

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was not that hard, probably worth it, I pushed it.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@Fidget-Spinner Fidget-Spinner Dec 17, 2020

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience and explaining it to me :).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
JulienPalard and others added 2 commits December 17, 2020 10:55
@JulienPalard @Fidget-Spinner
Update Doc/tools/rstlint.py
4ebd882
Co-authored-by: kj <[email protected]>
@JulienPalard
More specific removal of comments.
f7ca6df
Fidget-Spinner
Fidget-Spinner approved these changes Dec 17, 2020
View reviewed changes

@Fidget-Spinner Fidget-Spinner left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Once again, thanks for making this :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@bedevere-bot bedevere-bot added the awaiting core review label Dec 17, 2020
@JulienPalard
JulienPalard merged commit b973542 into python:master Dec 18, 2020
@bedevere-bot bedevere-bot removed the awaiting core review label Dec 18, 2020
@JulienPalard
JulienPalard deleted the doc-check branch December 18, 2020 09:48
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
@JulienPalard @adorilson
bpo-42238: Check Misc/NEWS.d/next/ for reStructuredText issues. (pyth…
f017116
…onGH-23802)
@JulienPalard JulienPalard mentioned this pull request Apr 10, 2022
Deprecate suspicious.py? #86404
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Fidget-Spinner Fidget-Spinner Fidget-Spinner approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@JulienPalard @Fidget-Spinner @the-knights-who-say-ni @bedevere-bot
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.