Take advantage of RST formatting for links
Use sphinx/rst for better links. Change-Id: I6aa22f30e0e49d461eb8b2f745d3366a008a6030
This commit is contained in:
parent
9c20ad8503
commit
a9a5e1d859
@ -1,3 +1,5 @@
|
||||
.. _StyleGuide:
|
||||
|
||||
OpenStack Style Guidelines
|
||||
==========================
|
||||
|
||||
@ -12,10 +14,11 @@ more maintainable.
|
||||
Step 0
|
||||
------
|
||||
|
||||
- Step 1: Read http://www.python.org/dev/peps/pep-0008/
|
||||
- Step 2: Read http://www.python.org/dev/peps/pep-0008/ again
|
||||
- Step 1: Read `pep8`_
|
||||
- Step 2: Read `pep8`_ again
|
||||
- Step 3: Read on
|
||||
|
||||
.. _`pep8`: http://www.python.org/dev/peps/pep-0008/
|
||||
|
||||
General
|
||||
-------
|
||||
|
@ -1,8 +1,7 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
hacking is a set of flake8 plugins that test and enforce the `OpenStack
|
||||
Style Guidlines <http://docs.openstack.org/developer/hacking>`_.
|
||||
hacking is a set of flake8 plugins that test and enforce the :ref:`StyleGuide`.
|
||||
|
||||
Hacking pins its dependencies, as a new release of some dependency can break
|
||||
hacking based gating jobs. This is because new versions of dependencies can
|
||||
@ -77,9 +76,8 @@ Requirements
|
||||
------------
|
||||
- The check must already have community support. We do not want to dictate
|
||||
style, only enforce it.
|
||||
- The canonical source of the OpenStack Style Guidelines is
|
||||
`HACKING.rst
|
||||
<http://docs.openstack.org/developer/hacking>`_, and hacking just enforces
|
||||
- The canonical source of the OpenStack Style Guidelines is :ref:`StyleGuide`,
|
||||
and hacking just enforces
|
||||
them; so when adding a new check, it must be in ``HACKING.rst``
|
||||
- False negatives are ok, but false positives are not
|
||||
- Cannot be project specific, project specific checks should be `Local Checks`_
|
||||
|
Loading…
Reference in New Issue
Block a user