openstack/hacking
Code Issues Proposed changes

Fix up some README formatting

Browse Source 
Change-Id: Iefb31041a3fbb4366b2a31e7d160428e2da45c78
This commit is contained in:
Tim Burke 2024-12-19 08:56:32 -08:00
parent ad22d7ce96
commit abff65f29b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -117,10 +117,10 @@ Local Checks
hacking supports having local changes in a source tree. They need to hacking supports having local changes in a source tree. They need to
be registered individually in tox.ini: be registered individually in tox.ini:
Add to tox.ini a new section `flake8:local-plugins` and list each plugin with Add to tox.ini a new section ``flake8:local-plugins`` and list each plugin with
its entry-point. Additionally, you can add the path to the files its entry-point. Additionally, you can add the path to the files
containing the plugins so that the repository does not need to be containing the plugins so that the repository does not need to be
installed with the `paths` directive. installed with the ``paths`` directive.
.. code-block:: ini .. code-block:: ini
@ -132,7 +132,7 @@ installed with the `paths` directive.
./nova/hacking ./nova/hacking
The plugins, in the example above they live in The plugins, in the example above they live in
`nova/hacking/checks.py`, need to annotate all functions with `@core.flake8ext` ``nova/hacking/checks.py``, need to annotate all functions with ``@core.flake8ext``
.. code-block:: python .. code-block:: python