Skip to content

Commit

Permalink
Merge pull request twisted#116 from glasnt/topic/rst_syntax
Browse files Browse the repository at this point in the history
Correct RST syntax for CompatibilityPolicy link
  • Loading branch information
glyph authored Aug 22, 2016
2 parents 4e147f8 + 16b5eef commit c52753c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Code
- Use `Twisted's coding standards <http://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html>`_ as a guideline for code changes you make.
Some parts of Klein (eg. ``klein.resource.ensure_utf8_bytes``) do not adhere to the Twisted style guide, but changing that would break public APIs, which is worse than breaking the style guidelines.
Similarly, if you change existing code, following the Twisted style guide is good, but is less important than not breaking public APIs.
- Compatibility across versions is important: here are `Twisted's compatibility guidelines<https://twistedmatrix.com/trac/wiki/CompatibilityPolicy>`_, which Klein shares.
- Compatibility across versions is important: here are `Twisted's compatibility guidelines <https://twistedmatrix.com/trac/wiki/CompatibilityPolicy>`_, which Klein shares.
- If you're adding a new feature, please add a file with an example and some explanation to the `examples directory <https://github.com/twisted/klein/tree/master/docs/examples>`_, then add your example to ``/docs/index.rst``.
- Please run ``tox -e pyflakes`` to check for style issues in changed code.
PyFlakes and similar tools expose many small-but-common errors early enough that it's easy to remedy the problem.
Expand Down

0 comments on commit c52753c

Please sign in to comment.