Skip to content
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

docs/development "Key points": Two updates and general improvement #3205

Merged
merged 1 commit into from Jan 26, 2024

Conversation

0cjs
Copy link
Contributor

@0cjs 0cjs commented Jan 26, 2024

As usual, more details in the commit message.

Though this is actually a user-visible change, it's somewhat minor and applies to developers only, so I don't think it should have a changelog entry. But if you think it needs one, let me know (ideally with suggested wording) and I'll add it.

  • [✓] ran the linter to address style issues (tox -e fix)
  • [✓] wrote descriptive pull request text
  • [n/a] ensured there are test(s) validating the fix
  • [n/a] added news fragment in docs/changelog folder
  • [✓] updated/extended the documentation

- Rework the "stuff lint misses" point to make short lines a sub-point.
- Add a new sub-point for single-char variable names to the above.
- PRs changing things not visible to the end user do not require a
  changelog entry.
- Improve description of `tox -e fix`.
- A few minor grammar/punctuation/etc. fixes.
Copy link
Member

@gaborbernat gaborbernat left a comment

Choose a reason for hiding this comment

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

@gaborbernat gaborbernat merged commit 47fa093 into tox-dev:main Jan 26, 2024
24 of 25 checks passed
@0cjs 0cjs deleted the dev/cjs/24a27/docs-developer branch January 26, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants