Skip to content

Commit fd8572a

Browse files
committed
Merge pull request realpython#521 from vpzee/master
Fixing the urls pointing to the contribute page
2 parents da5d9d3 + 5aac29d commit fd8572a

File tree

5 files changed

+20
-16
lines changed

5 files changed

+20
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ How to contribute
44
This guide is under heavy development. If you would like to contribute, please
55
see:
66

7-
http://docs.python-guide.org/en/latest/notes/contribute/
7+
http://docs.python-guide.org/en/latest/notes/contribute.html
88

99

1010
Style Guide

docs/_templates/sidebarintro.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h3>Contributors</h3>
2323
This guide is the result of the collaboration of
2424
<a href="https://github.com/kennethreitz/python-guide/graphs/contributors">135+ people</a>
2525
around the world, and your contributions
26-
<a href="http://docs.python-guide.org/en/latest/notes/contribute/">are welcome</a>!
26+
<a href="http://docs.python-guide.org/en/latest/notes/contribute.html">are welcome</a>!
2727
</p>
2828

2929

docs/writing/documentation.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ of the following components:
4040
done with the product, using one or two extremely simplified use
4141
cases. This is the thirty-second pitch for your project.
4242

43-
- A *tutorial* should show some primary use cases in more detail. The reader will
44-
follow a step-by-step procedure to set-up a working prototype.
43+
- A *tutorial* should show some primary use cases in more detail. The reader
44+
will follow a step-by-step procedure to set-up a working prototype.
4545

4646
- An *API reference* is typically generated from the code (see
47-
:ref:`docstrings <docstring-ref>`). It will list all publicly available interfaces,
48-
parameters, and return values.
47+
:ref:`docstrings <docstring-ref>`). It will list all publicly available
48+
interfaces, parameters, and return values.
4949

5050
- *Developer documentation* is intended for potential contributors. This can
5151
include code convention and general design strategy of the project.
@@ -107,7 +107,8 @@ In Python, *docstrings* describe modules, classes, and functions:
107107
"""Returns the square root of self times self."""
108108
...
109109
110-
In general, follow the comment section of :pep:`8#comments` (the "Python Style Guide").
110+
In general, follow the comment section of :pep:`8#comments` (the "Python Style
111+
Guide").
111112

112113
Commenting Sections of Code
113114
~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/writing/gotchas.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ avoids surprises. However, there are a few cases that can be confusing to
66
newcomers.
77

88
Some of these cases are intentional but can be potentially surprising. Some
9-
could arguably be considered language warts. In general though, what follows is a collection
10-
of potentially tricky behavior that might seem strange at first glance, but is
11-
generally sensible once you're aware of the underlying cause for the surprise.
9+
could arguably be considered language warts. In general though, what follows
10+
is a collection of potentially tricky behavior that might seem strange at first
11+
glance, but is generally sensible once you're aware of the underlying cause for
12+
the surprise.
1213

1314

1415
.. _default_args:
@@ -139,7 +140,8 @@ completed and ``i`` is left with its final value of 4.
139140
What's particularly nasty about this gotcha is the seemingly prevalent
140141
misinformation that this has something to do with :ref:`lambdas <python:lambda>`
141142
in Python. Functions created with a ``lambda`` expression are in no way special,
142-
and in fact the same exact behavior is exhibited by just using an ordinary ``def``:
143+
and in fact the same exact behavior is exhibited by just using an ordinary
144+
``def``:
143145

144146
.. code-block:: python
145147
@@ -179,6 +181,6 @@ Alternatively, you can use the functools.partial function:
179181
When the Gotcha Isn't a Gotcha
180182
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181183

182-
Sometimes you want your closures to behave this way. Late binding is good in lots of
183-
situations. Looping to create unique functions is unfortunately a case where
184-
they can cause hiccups.
184+
Sometimes you want your closures to behave this way. Late binding is good in
185+
lots of situations. Looping to create unique functions is unfortunately a case
186+
where they can cause hiccups.

docs/writing/license.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,6 @@ To help you choose one for your project, there's a `license chooser <http://choo
4848
+ GPLv2
4949
+ GPLv3
5050

51-
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 <https://tldrlegal.com/>`_.
52-
51+
A good overview of licenses with explanations of what one can, cannot,
52+
and must do using a particular software can be found at
53+
`tl;drLegal <https://tldrlegal.com/>`_.

0 commit comments

Comments
 (0)