Skip to content

pre-commit: rst: allow pytest directives in changelog entries #4283

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

Closed
blueyed opened this issue Oct 31, 2018 · 8 comments
Closed

pre-commit: rst: allow pytest directives in changelog entries #4283

blueyed opened this issue Oct 31, 2018 · 8 comments
Labels
type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch type: infrastructure improvement to development/releases/CI structure

Comments

@blueyed
Copy link
Contributor

blueyed commented Oct 31, 2018

Via: #4271 (comment)

It is useful to link options etc in changelog entries, but linting fails on them.

@blueyed blueyed added type: enhancement new feature or API change, should be merged into features branch type: docs documentation improvement, missing or needing clarification labels Oct 31, 2018
@asottile asottile added the type: infrastructure improvement to development/releases/CI structure label Oct 31, 2018
@asottile
Copy link
Member

rst-lint is quite inflexible, there isn't really anything that can be done here

@blueyed
Copy link
Contributor Author

blueyed commented Nov 20, 2019

Well, not using it in the first place would be an option.
We're checking docs already for every PR in total, and should/could then instead check them with a generated CHANGELOG.rst then.

@asottile
Copy link
Member

🤷‍♂️ rst-lint has definitely saved me in changelogs before, I expect it to be even more helpful to those not familiar with the intricacies of rst

@nicoddemus
Copy link
Member

👍 on keeping rst-lint: it also checks the changelog entries, while the generated changelog is only materialized on releases. It would make the release task much more frustating if it meant having to fix rst syntax problems in the CHANGELOG.

@blueyed
Copy link
Contributor Author

blueyed commented Nov 20, 2019

should/could then instead check them with a generated CHANGELOG.rst then.

@blueyed
Copy link
Contributor Author

blueyed commented Nov 20, 2019

I would not sacrifice better documentation because of it.

(Also for linting rst in general I recommend using a linter / syntax highlighting in your editor already.)

@nicoddemus
Copy link
Member

You mean generating the CHANGELOG during docs and checking that?

That would bring the advantage of using full rst syntax and directives (say :ref:fixtures)... it is an interesting idea indeed.

@blueyed
Copy link
Contributor Author

blueyed commented Nov 21, 2019

Exactly.

blueyed added a commit to blueyed/pytest that referenced this issue Nov 25, 2019
blueyed added a commit to blueyed/pytest that referenced this issue Nov 25, 2019
blueyed added a commit to blueyed/pytest that referenced this issue Nov 25, 2019
blueyed added a commit to blueyed/pytest that referenced this issue Nov 25, 2019
@blueyed blueyed closed this as completed Nov 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification type: enhancement new feature or API change, should be merged into features branch type: infrastructure improvement to development/releases/CI structure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants