From 95fec953a90c16fe8e6450ab346ec002c84f2e43 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Fri, 7 Dec 2018 09:16:07 +0100 Subject: [PATCH] Better wording --- .github/CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 0e0fa6c2..3c4a183f 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -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".