From c7b1a0bbe2ae298ba0471703ad6d5ef86ae5881d Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sat, 26 Nov 2016 13:43:28 +0200 Subject: [PATCH] Issue #28763: Use double hyphens (rendered as en-dashes) in numerical ranges in the documentation. --- Doc/faq/design.rst | 4 ++-- Doc/faq/general.rst | 2 +- Doc/howto/urllib2.rst | 4 ++-- Doc/library/calendar.rst | 2 +- Doc/library/cmath.rst | 2 +- Doc/library/codecs.rst | 6 +++--- Doc/library/curses.ascii.rst | 2 +- Doc/library/curses.rst | 2 +- Doc/library/functions.rst | 2 +- Doc/library/ipaddress.rst | 2 +- Doc/library/json.rst | 2 +- Doc/library/random.rst | 2 +- Doc/library/statistics.rst | 6 +++--- Doc/library/sys.rst | 2 +- Doc/whatsnew/2.1.rst | 2 +- Doc/whatsnew/2.7.rst | 4 ++-- Doc/whatsnew/3.5.rst | 4 ++-- 17 files changed, 25 insertions(+), 25 deletions(-) diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index 1b6cd7e241..108df6d17a 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -31,7 +31,7 @@ least slightly uneasy when reading (or being required to write) another style. Many coding styles place begin/end brackets on a line by themselves. This makes programs considerably longer and wastes valuable screen space, making it harder to get a good overview of a program. Ideally, a function should fit on one -screen (say, 20-30 lines). 20 lines of Python can do a lot more work than 20 +screen (say, 20--30 lines). 20 lines of Python can do a lot more work than 20 lines of C. This is not solely due to the lack of begin/end brackets -- the lack of declarations and the high-level data types are also responsible -- but the indentation-based syntax certainly helps. @@ -77,7 +77,7 @@ which is exactly:: 1.1999999999999999555910790149937383830547332763671875 (decimal) -The typical precision of 53 bits provides Python floats with 15-16 +The typical precision of 53 bits provides Python floats with 15--16 decimal digits of accuracy. For a fuller explanation, please see the :ref:`floating point arithmetic diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 3f96700b2d..f1e33afdab 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -252,7 +252,7 @@ outdated. Guido van Rossum and Jelke de Boer, "Interactively Testing Remote Servers Using the Python Programming Language", CWI Quarterly, Volume 4, Issue 4 - (December 1991), Amsterdam, pp 283-303. + (December 1991), Amsterdam, pp 283--303. Are there any books on Python? diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst index d2c799196b..712b4b7623 100644 --- a/Doc/howto/urllib2.rst +++ b/Doc/howto/urllib2.rst @@ -240,8 +240,8 @@ Error Codes ~~~~~~~~~~~ Because the default handlers handle redirects (codes in the 300 range), and -codes in the 100-299 range indicate success, you will usually only see error -codes in the 400-599 range. +codes in the 100--299 range indicate success, you will usually only see error +codes in the 400--599 range. :attr:`http.server.BaseHTTPRequestHandler.responses` is a useful dictionary of response codes in that shows all the response codes used by RFC 2616. The diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst index df76e33668..41e9e28e0c 100644 --- a/Doc/library/calendar.rst +++ b/Doc/library/calendar.rst @@ -47,7 +47,7 @@ it's the base calendar for all computations. .. method:: itermonthdates(year, month) - Return an iterator for the month *month* (1-12) in the year *year*. This + Return an iterator for the month *month* (1--12) in the year *year*. This iterator will return all days (as :class:`datetime.date` objects) for the month and all days before the start of the month or after the end of the month that are required to get a complete week. diff --git a/Doc/library/cmath.rst b/Doc/library/cmath.rst index 62ddb6bc48..e113ffc3e5 100644 --- a/Doc/library/cmath.rst +++ b/Doc/library/cmath.rst @@ -275,6 +275,6 @@ cuts for numerical purposes, a good reference should be the following: Kahan, W: Branch cuts for complex elementary functions; or, Much ado about nothing's sign bit. In Iserles, A., and Powell, M. (eds.), The state of the art - in numerical analysis. Clarendon Press (1987) pp165-211. + in numerical analysis. Clarendon Press (1987) pp165--211. diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 03f0228476..f38e41bff5 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -858,7 +858,7 @@ Encodings and Unicode --------------------- Strings are stored internally as sequences of code points in -range ``0x0``-``0x10FFFF``. (See :pep:`393` for +range ``0x0``--``0x10FFFF``. (See :pep:`393` for more details about the implementation.) Once a string object is used outside of CPU and memory, endianness and how these arrays are stored as bytes become an issue. As with other @@ -868,7 +868,7 @@ There are a variety of different text serialisation codecs, which are collectivity referred to as :term:`text encodings `. The simplest text encoding (called ``'latin-1'`` or ``'iso-8859-1'``) maps -the code points 0-255 to the bytes ``0x0``-``0xff``, which means that a string +the code points 0--255 to the bytes ``0x0``--``0xff``, which means that a string object that contains code points above ``U+00FF`` can't be encoded with this codec. Doing so will raise a :exc:`UnicodeEncodeError` that looks like the following (although the details of the error message may differ): @@ -877,7 +877,7 @@ position 3: ordinal not in range(256)``. There's another group of encodings (the so called charmap encodings) that choose a different subset of all Unicode code points and how these code points are -mapped to the bytes ``0x0``-``0xff``. To see how this is done simply open +mapped to the bytes ``0x0``--``0xff``. To see how this is done simply open e.g. :file:`encodings/cp1252.py` (which is an encoding that is used primarily on Windows). There's a string constant with 256 characters that shows you which character is mapped to which byte value. diff --git a/Doc/library/curses.ascii.rst b/Doc/library/curses.ascii.rst index db3c827406..b6ac251733 100644 --- a/Doc/library/curses.ascii.rst +++ b/Doc/library/curses.ascii.rst @@ -213,7 +213,7 @@ it returns a string. Return a string representation of the ASCII character *c*. If *c* is printable, this string is the character itself. If the character is a control character - (0x00-0x1f) the string consists of a caret (``'^'``) followed by the + (0x00--0x1f) the string consists of a caret (``'^'``) followed by the corresponding uppercase letter. If the character is an ASCII delete (0x7f) the string is ``'^?'``. If the character has its meta bit (0x80) set, the meta bit is stripped, the preceding rules applied, and ``'!'`` prepended to the result. diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst index b12a325f37..d746eafaea 100644 --- a/Doc/library/curses.rst +++ b/Doc/library/curses.rst @@ -316,7 +316,7 @@ The module :mod:`curses` defines the following functions: Return the name of the key numbered *k*. The name of a key generating printable ASCII character is the key's character. The name of a control-key combination is a two-character string consisting of a caret followed by the corresponding - printable ASCII character. The name of an alt-key combination (128-255) is a + printable ASCII character. The name of an alt-key combination (128--255) is a string consisting of the prefix 'M-' followed by the name of the corresponding ASCII character. diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index fcd160e8b3..2f14949e1f 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -686,7 +686,7 @@ are always available. They are listed here in alphabetical order. preceded by ``+`` or ``-`` (with no space in between) and surrounded by whitespace. A base-n literal consists of the digits 0 to n-1, with ``a`` to ``z`` (or ``A`` to ``Z``) having - values 10 to 35. The default *base* is 10. The allowed values are 0 and 2-36. + values 10 to 35. The default *base* is 10. The allowed values are 0 and 2--36. Base-2, -8, and -16 literals can be optionally prefixed with ``0b``/``0B``, ``0o``/``0O``, or ``0x``/``0X``, as with integer literals in code. Base 0 means to interpret exactly as a code literal, so that the actual base is 2, diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst index 9db0a70c73..50fb778dfb 100644 --- a/Doc/library/ipaddress.rst +++ b/Doc/library/ipaddress.rst @@ -99,7 +99,7 @@ write code that handles both IP versions correctly. The following constitutes a valid IPv4 address: 1. A string in decimal-dot notation, consisting of four decimal integers in - the inclusive range 0-255, separated by dots (e.g. ``192.168.0.1``). Each + the inclusive range 0--255, separated by dots (e.g. ``192.168.0.1``). Each integer represents an octet (byte) in the address. Leading zeroes are tolerated only for values less than 8 (as there is no ambiguity between the decimal and octal interpretations of such strings). diff --git a/Doc/library/json.rst b/Doc/library/json.rst index 858a59e3c5..f487535609 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -338,7 +338,7 @@ Encoders and Decoders If *strict* is false (``True`` is the default), then control characters will be allowed inside strings. Control characters in this context are - those with character codes in the 0-31 range, including ``'\t'`` (tab), + those with character codes in the 0--31 range, including ``'\t'`` (tab), ``'\n'``, ``'\r'`` and ``'\0'``. If the data being deserialized is not a valid JSON document, a diff --git a/Doc/library/random.rst b/Doc/library/random.rst index 22f18a0cd5..8ae242c029 100644 --- a/Doc/library/random.rst +++ b/Doc/library/random.rst @@ -266,7 +266,7 @@ Alternative Generator: M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator", ACM Transactions on - Modeling and Computer Simulation Vol. 8, No. 1, January pp.3-30 1998. + Modeling and Computer Simulation Vol. 8, No. 1, January pp.3--30 1998. `Complementary-Multiply-with-Carry recipe diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index ea3d7dab0f..7685621385 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -191,9 +191,9 @@ However, for reading convenience, most of the examples show sorted sequences. 52.5 In the following example, the data are rounded, so that each value represents - the midpoint of data classes, e.g. 1 is the midpoint of the class 0.5-1.5, 2 - is the midpoint of 1.5-2.5, 3 is the midpoint of 2.5-3.5, etc. With the data - given, the middle value falls somewhere in the class 3.5-4.5, and + the midpoint of data classes, e.g. 1 is the midpoint of the class 0.5--1.5, 2 + is the midpoint of 1.5--2.5, 3 is the midpoint of 2.5--3.5, etc. With the data + given, the middle value falls somewhere in the class 3.5--4.5, and interpolation is used to estimate it: .. doctest:: diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 7aed75d483..d28ea5db92 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -256,7 +256,7 @@ always available. (defaulting to zero), or another type of object. If it is an integer, zero is considered "successful termination" and any nonzero value is considered "abnormal termination" by shells and the like. Most systems require it to be - in the range 0-127, and produce undefined results otherwise. Some systems + in the range 0--127, and produce undefined results otherwise. Some systems have a convention for assigning specific meanings to specific exit codes, but these are generally underdeveloped; Unix programs generally use 2 for command line syntax errors and 1 for all other kind of errors. If another type of diff --git a/Doc/whatsnew/2.1.rst b/Doc/whatsnew/2.1.rst index be72bfe211..00151d7820 100644 --- a/Doc/whatsnew/2.1.rst +++ b/Doc/whatsnew/2.1.rst @@ -731,7 +731,7 @@ of the more notable changes are: ... For a fuller discussion of the line I/O changes, see the python-dev summary for - January 1-15, 2001 at https://mail.python.org/pipermail/python-dev/2001-January/. + January 1--15, 2001 at https://mail.python.org/pipermail/python-dev/2001-January/. * A new method, :meth:`popitem`, was added to dictionaries to enable destructively iterating through the contents of a dictionary; this can be faster diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index ad0616bc23..55392fc2be 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -104,7 +104,7 @@ Some key consequences of the long-term significance of 2.7 are: when compared to earlier 2.x versions. Python 2.7 is currently expected to remain supported by the core development team (receiving security updates and other bug fixes) until at least 2020 (10 years after its initial - release, compared to the more typical support period of 18-24 months). + release, compared to the more typical support period of 18--24 months). * As the Python 2.7 standard library ages, making effective use of the Python Package Index (either directly or via a redistributor) becomes @@ -989,7 +989,7 @@ Several performance enhancements have been added: Gregory Smith; :issue:`1087418`). * The implementation of ``%`` checks for the left-side operand being - a Python string and special-cases it; this results in a 1-3% + a Python string and special-cases it; this results in a 1--3% performance increase for applications that frequently use ``%`` with strings, such as templating libraries. (Implemented by Collin Winter; :issue:`5176`.) diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst index ec2bc5b799..ab61d7a6d4 100644 --- a/Doc/whatsnew/3.5.rst +++ b/Doc/whatsnew/3.5.rst @@ -2129,8 +2129,8 @@ Many operations on :class:`io.BytesIO` are now 50% to 100% faster. (Contributed by Serhiy Storchaka in :issue:`15381` and David Wilson in :issue:`22003`.) -The :func:`marshal.dumps` function is now faster: 65-85% with versions 3 -and 4, 20-25% with versions 0 to 2 on typical data, and up to 5 times in +The :func:`marshal.dumps` function is now faster: 65--85% with versions 3 +and 4, 20--25% with versions 0 to 2 on typical data, and up to 5 times in best cases. (Contributed by Serhiy Storchaka in :issue:`20416` and :issue:`23344`.) -- 2.40.0