diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca09a1f..0035989 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ How to contribute This guide is under heavy development. If you would like to contribute, please see: -http://python-guide.readthedocs.org/en/latest/notes/contribute.html +http://docs.python-guide.org/en/latest/notes/contribute.html Style Guide diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index ecb9f39..0bfc69a 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -23,7 +23,7 @@ This guide is the result of the collaboration of 135+ people around the world, and your contributions - are welcome! + are welcome!

diff --git a/docs/writing/documentation.rst b/docs/writing/documentation.rst index 0aeb77b..85f48de 100644 --- a/docs/writing/documentation.rst +++ b/docs/writing/documentation.rst @@ -40,12 +40,12 @@ of the following components: done with the product, using one or two extremely simplified use cases. This is the thirty-second pitch for your project. -- A *tutorial* should show some primary use cases in more detail. The reader will - follow a step-by-step procedure to set-up a working prototype. +- A *tutorial* should show some primary use cases in more detail. The reader + will follow a step-by-step procedure to set-up a working prototype. - An *API reference* is typically generated from the code (see - :ref:`docstrings `). It will list all publicly available interfaces, - parameters, and return values. + :ref:`docstrings `). It will list all publicly available + interfaces, parameters, and return values. - *Developer documentation* is intended for potential contributors. This can include code convention and general design strategy of the project. @@ -107,7 +107,8 @@ In Python, *docstrings* describe modules, classes, and functions: """Returns the square root of self times self.""" ... -In general, follow the comment section of :pep:`8#comments` (the "Python Style Guide"). +In general, follow the comment section of :pep:`8#comments` (the "Python Style +Guide"). Commenting Sections of Code ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/writing/gotchas.rst b/docs/writing/gotchas.rst index a59eb9b..b12fbd5 100644 --- a/docs/writing/gotchas.rst +++ b/docs/writing/gotchas.rst @@ -6,9 +6,10 @@ avoids surprises. However, there are a few cases that can be confusing to newcomers. Some of these cases are intentional but can be potentially surprising. Some -could arguably be considered language warts. In general though, what follows is a collection -of potentially tricky behavior that might seem strange at first glance, but is -generally sensible once you're aware of the underlying cause for the surprise. +could arguably be considered language warts. In general though, what follows +is a collection of potentially tricky behavior that might seem strange at first +glance, but is generally sensible once you're aware of the underlying cause for +the surprise. .. _default_args: @@ -139,7 +140,8 @@ completed and ``i`` is left with its final value of 4. What's particularly nasty about this gotcha is the seemingly prevalent misinformation that this has something to do with :ref:`lambdas ` in Python. Functions created with a ``lambda`` expression are in no way special, -and in fact the same exact behavior is exhibited by just using an ordinary ``def``: +and in fact the same exact behavior is exhibited by just using an ordinary +``def``: .. code-block:: python @@ -179,6 +181,6 @@ Alternatively, you can use the functools.partial function: When the Gotcha Isn't a Gotcha ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sometimes you want your closures to behave this way. Late binding is good in lots of -situations. Looping to create unique functions is unfortunately a case where -they can cause hiccups. +Sometimes you want your closures to behave this way. Late binding is good in +lots of situations. Looping to create unique functions is unfortunately a case +where they can cause hiccups. diff --git a/docs/writing/license.rst b/docs/writing/license.rst index 60099ea..0a5256b 100644 --- a/docs/writing/license.rst +++ b/docs/writing/license.rst @@ -48,5 +48,6 @@ To help you choose one for your project, there's a `license chooser `_. - +A good overview of licenses with explanations of what one can, cannot, +and must do using a particular software can be found at +`tl;drLegal `_.