-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Infra: add newlines so admonition text is shown #3756
Conversation
And remove text duplicating that inserted by the template.
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
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.
The need for a newline feels a bit like a footgun, is there a way to address that, or have it show up as a lint warning?
Will check into that before doing the next batch, it might be something to do with how these custom directives set |
AFAIK that's normal ReST syntax: the blank line separates a directive's arguments/options from its content. I don't see a good way to disable the argument-continuation/option block, short of parsing the entire directive manually (using Perhaps it'd be best to warn/error on suspicious cases:
|
I wrote a long blurb here and realised it would be easier to just draft up the change -- so, filed #3765 as a potential way forward here. |
Follow on from #3682.
Re: #3682 (comment)
And remove text duplicating that inserted by the template.
Previews:
📚 Documentation preview 📚: https://pep-previews--3756.org.readthedocs.build/