Skip to content

Commit

Permalink
Merge doc fixups from 3.6
Browse files Browse the repository at this point in the history
  • Loading branch information
vadmium committed Nov 21, 2016
2 parents fbf12dc + e262763 commit 9557bb7
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
30 changes: 15 additions & 15 deletions Doc/howto/clinic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Argument Clinic's primary goal
is to take over responsibility for all argument parsing code
inside CPython. This means that, when you convert a function
to work with Argument Clinic, that function should no longer
do any of its own argument parsing--the code generated by
do any of its own argument parsingthe code generated by
Argument Clinic should be a "black box" to you, where CPython
calls in at the top, and your code gets called at the bottom,
with ``PyObject *args`` (and maybe ``PyObject *kwargs``)
Expand All @@ -43,12 +43,12 @@ redundant information in a surprising number of places.
When you use Argument Clinic, you don't have to repeat yourself.

Obviously, no one would want to use Argument Clinic unless
it's solving their problem--and without creating new problems of
it's solving their problemand without creating new problems of
its own.
So it's paramount that Argument Clinic generate correct code.
It'd be nice if the code was faster, too, but at the very least
it should not introduce a major speed regression. (Eventually Argument
Clinic *should* make a major speedup possible--we could
Clinic *should* make a major speedup possiblewe could
rewrite its code generator to produce tailor-made argument
parsing code, rather than calling the general-purpose CPython
argument parsing library. That would make for the fastest
Expand Down Expand Up @@ -113,7 +113,7 @@ line. However, if the input hasn't changed, the output won't change either.

You should never modify the output portion of an Argument Clinic block. Instead,
change the input until it produces the output you want. (That's the purpose of the
checksum--to detect if someone changed the output, as these edits would be lost
checksumto detect if someone changed the output, as these edits would be lost
the next time Argument Clinic writes out fresh output.)

For the sake of clarity, here's the terminology we'll use with Argument Clinic:
Expand Down Expand Up @@ -166,7 +166,7 @@ Let's dive in!
or if it has multiple calls to :c:func:`PyArg_ParseTuple`,
you should choose a different function. Argument Clinic *does*
support all of these scenarios. But these are advanced
topics--let's do something simpler for your first function.
topicslet's do something simpler for your first function.

Also, if the function has multiple calls to :c:func:`PyArg_ParseTuple`
or :c:func:`PyArg_ParseTupleAndKeywords` where it supports different
Expand All @@ -188,7 +188,7 @@ Let's dive in!

If the old docstring had a first line that looked like a function
signature, throw that line away. (The docstring doesn't need it
anymore--when you use ``help()`` on your builtin in the future,
anymorewhen you use ``help()`` on your builtin in the future,
the first line will be built automatically based on the function's
signature.)

Expand All @@ -209,7 +209,7 @@ Let's dive in!
6. Above the docstring, enter the name of the function, followed
by a blank line. This should be the Python name of the function,
and should be the full dotted path
to the function--it should start with the name of the module,
to the functionit should start with the name of the module,
include any sub-modules, and if the function is a method on
a class it should include the class name too.

Expand Down Expand Up @@ -275,7 +275,7 @@ Let's dive in!
What's a "converter"? It establishes both the type
of the variable used in C, and the method to convert the Python
value into a C value at runtime.
For now you're going to use what's called a "legacy converter"--a
For now you're going to use what's called a "legacy converter"a
convenience syntax intended to make porting old code into Argument
Clinic easier.

Expand Down Expand Up @@ -425,7 +425,7 @@ Let's dive in!
(Argument Clinic always generates its format strings
with a ``:`` followed by the name of the function. If the
existing code's format string ends with ``;``, to provide
usage help, this change is harmless--don't worry about it.)
usage help, this change is harmlessdon't worry about it.)

Third, for parameters whose format units require two arguments
(like a length variable, or an encoding string, or a pointer
Expand Down Expand Up @@ -638,7 +638,7 @@ an optional argument on the *left* side of its required argument!
Another example is ``curses.window.addch()``, which has a group of two
arguments that must always be specified together. (The arguments are
called ``x`` and ``y``; if you call the function passing in ``x``,
you must also pass in ``y``--and if you don't pass in ``x`` you may not
you must also pass in ``y``and if you don't pass in ``x`` you may not
pass in ``y`` either.)

In any case, the goal of Argument Clinic is to support argument parsing
Expand Down Expand Up @@ -889,7 +889,7 @@ Advanced converters
Remember those format units you skipped for your first
time because they were advanced? Here's how to handle those too.

The trick is, all those format units take arguments--either
The trick is, all those format units take argumentseither
conversion functions, or types, or strings specifying an encoding.
(But "legacy converters" don't support arguments. That's why we
skipped them for your first function.) The argument you specified
Expand Down Expand Up @@ -1003,7 +1003,7 @@ Using a return converter
By default the impl function Argument Clinic generates for you returns ``PyObject *``.
But your C function often computes some C type, then converts it into the ``PyObject *``
at the last moment. Argument Clinic handles converting your inputs from Python types
into native C types--why not have it convert your return value from a native C type
into native C typeswhy not have it convert your return value from a native C type
into a Python type too?

That's what a "return converter" does. It changes your impl function to return
Expand Down Expand Up @@ -1185,7 +1185,7 @@ Writing a custom converter
As we hinted at in the previous section... you can write your own converters!
A converter is simply a Python class that inherits from ``CConverter``.
The main purpose of a custom converter is if you have a parameter using
the ``O&`` format unit--parsing this parameter means calling
the ``O&`` format unitparsing this parameter means calling
a :c:func:`PyArg_ParseTuple` "converter function".

Your converter class should be named ``*something*_converter``.
Expand Down Expand Up @@ -1227,7 +1227,7 @@ to specify in your subclass. Here's the current list:
The default value used to initialize the C variable when
there is no default, but not specifying a default may
result in an "uninitialized variable" warning. This can
easily happen when using option groups--although
easily happen when using option groupsalthough
properly-written code will never actually use this value,
the variable does get passed in to the impl, and the
C compiler will complain about the "use" of the
Expand Down Expand Up @@ -1403,7 +1403,7 @@ Let's start with defining some terminology:
all of processing, even from Clinic blocks *after* the

``suppress``
The text is suppressed--thrown away.
The text is suppressedthrown away.


Clinic defines five new directives that let you reconfigure its output.
Expand Down
2 changes: 1 addition & 1 deletion Doc/howto/cporting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ long/int Unification
--------------------

Python 3 has only one integer type, :func:`int`. But it actually
corresponds to Python 2's :func:`long` type--the :func:`int` type
corresponds to Python 2's :func:`long` typethe :func:`int` type
used in Python 2 was removed. In the C-API, ``PyInt_*`` functions
are replaced by their ``PyLong_*`` equivalents.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -959,7 +959,7 @@ are always available. They are listed here in alphabetical order.
the list of supported encodings.

*errors* is an optional string that specifies how encoding and decoding
errors are to be handled--this cannot be used in binary mode.
errors are to be handledthis cannot be used in binary mode.
A variety of standard error handlers are available
(listed under :ref:`error-handlers`), though any
error handling name that has been registered with
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/hmac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ This module also provides the following helper function:

If *a* and *b* are of different lengths, or if an error occurs,
a timing attack could theoretically reveal information about the
types and lengths of *a* and *b*--but not their values.
types and lengths of *a* and *b*but not their values.


.. versionadded:: 3.3
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/pdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ by the local file.
return, jump, quit and their abbreviations) terminates the command list (as if
that command was immediately followed by end). This is because any time you
resume execution (even with a simple next or step), you may encounter another
breakpoint--which could have its own command list, leading to ambiguities about
breakpointwhich could have its own command list, leading to ambiguities about
which list to execute.

If you use the 'silent' command in the command list, the usual message about
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/shutil.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Directory and files operations
If *follow_symlinks* is false, and *src* and *dst* both
refer to symbolic links, :func:`copystat` will operate on
the symbolic links themselves rather than the files the
symbolic links refer to--reading the information from the
symbolic links refer toreading the information from the
*src* symbolic link, and writing the information to the
*dst* symbolic link.

Expand Down
2 changes: 1 addition & 1 deletion Doc/reference/datamodel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2550,7 +2550,7 @@ An example of an asynchronous context manager class::
.. [#] "Does not support" here means that the class has no such method, or
the method returns ``NotImplemented``. Do not set the method to
``None`` if you want to force fallback to the right operand's reflected
method--that will instead have the opposite effect of explicitly
methodthat will instead have the opposite effect of explicitly
*blocking* such fallback.
.. [#] For operands of the same type, it is assumed that if the non-reflected method
Expand Down

0 comments on commit 9557bb7

Please sign in to comment.