Rooba
/
attrs
mirror of https://github.com/python-attrs/attrs.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add more sensical example

This commit is contained in:
Hynek Schlawack 2021-11-26 07:19:16 +01:00
parent ff65c6e645
commit ebe158cf8a
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/CONTRIBUTING.md vendored
View File

@ -117,8 +117,10 @@ You don't need to install *towncrier* yourself, you just have to abide by a few
For example, `changelog.d/42.change.rst` for a non-breaking change that is proposed in pull request #42. For example, `changelog.d/42.change.rst` for a non-breaking change that is proposed in pull request #42.
- As with other docs, please use [semantic newlines] within news fragments. - As with other docs, please use [semantic newlines] within news fragments.
- Wrap symbols like modules, functions, or classes into double backticks so they are rendered in a `monospace font`. - Wrap symbols like modules, functions, or classes into double backticks so they are rendered in a `monospace font`.
- Wrap arguments into asterisks like in docstrings: *these* or *attributes*. - Wrap arguments into asterisks like in docstrings:
- If you mention functions or other callables, add parentheses at the end of their names: `attr.func()` or `attr.Class.method()`. `Added new argument *an_argument*.`
- If you mention functions or other callables, add parentheses at the end of their names:
`attr.func()` or `attr.Class.method()`.
This makes the changelog a lot more readable. This makes the changelog a lot more readable.
- Prefer simple past tense or constructions with "now". - Prefer simple past tense or constructions with "now".
For example: For example: