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

Better wording

This commit is contained in:
Hynek Schlawack 2018-12-07 09:16:07 +01:00
parent 9bed98c35d
commit 95fec953a9
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.rst vendored
View File

@ -117,8 +117,8 @@ You don't need to install ``towncrier`` yourself, you just have to abide by a fe
- For each pull request, add a new file into ``changelog.d`` with a filename adhering to the ``pr#.(change|deprecation|breaking).rst`` schema:
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.
- Wrap symbols like modules, functions, or classes into double backticks so they are rendered in a monospace font.
- Wrap arguments into asterisks like in autodocs: *these* or *attributes*.
- 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*.
- 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.
- Prefer simple past tense or constructions with "now".