Skip to content

Commit 39e2879

Browse files
authored
Fix typos and grammar in documentation and CHANGES (#402)
- Fix extra spaces in MAXSIZE description (documentation/index.rst) - Add missing periods to ensure_binary/ensure_str/ensure_text descriptions - Fix "workaround" -> "work around" (verb form) - Fix "Neither have" -> "Neither has" (singular verb) - Add missing word "module" after collections.abc (CHANGES) - Add missing word "is" in "This exactly the same" (CHANGES) - Add missing word "it" in "where is available" (CHANGES)
1 parent e9da069 commit 39e2879

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CHANGES

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This file lists the changes in each six version.
4343
- Issue #298, pull request #299: Add `six.moves.dbm_ndbm`.
4444

4545
- Issue #155: Add `six.moves.collections_abc`, which aliases the `collections`
46-
module on Python 2-3.2 and the `collections.abc` on Python 3.3 and greater.
46+
module on Python 2-3.2 and the `collections.abc` module on Python 3.3 and greater.
4747

4848
- Pull request #304: Re-add distutils fallback in `setup.py`.
4949

@@ -275,7 +275,7 @@ This file lists the changes in each six version.
275275

276276
- Issue #23: Allow multiple base classes to be passed to with_metaclass.
277277

278-
- Issue #24: Add six.moves.range alias. This exactly the same as the current
278+
- Issue #24: Add six.moves.range alias. This is exactly the same as the current
279279
xrange alias.
280280

281281
- Pull request #5: Create six.moves.urllib, which contains abstractions for a
@@ -318,7 +318,7 @@ This file lists the changes in each six version.
318318

319319
- Add six.next() as an alias for six.advance_iterator().
320320

321-
- Use the builtin next() function for advance_iterator() where is available
321+
- Use the builtin next() function for advance_iterator() where it is available
322322
(2.6+), not just Python 3.
323323

324324
- Add the Iterator class for writing portable iterators.

documentation/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,11 @@ Six provides constants that may differ between Python versions. Ones ending
8383

8484
.. data:: MAXSIZE
8585

86-
The maximum size of a container like :func:`py3:list` or :func:`py3:dict`.
87-
This is equivalent to :data:`py3:sys.maxsize` in Python 2.6 and later
88-
(including 3.x). Note, this is temptingly similar to, but not the same as
89-
:data:`py2:sys.maxint` in Python 2. There is no direct equivalent to
90-
:data:`py2:sys.maxint` in Python 3 because its integer type has no limits
86+
The maximum size of a container like :func:`py3:list` or :func:`py3:dict`.
87+
This is equivalent to :data:`py3:sys.maxsize` in Python 2.6 and later
88+
(including 3.x). Note, this is temptingly similar to, but not the same as
89+
:data:`py2:sys.maxint` in Python 2. There is no direct equivalent to
90+
:data:`py2:sys.maxint` in Python 3 because its integer type has no limits
9191
aside from memory.
9292

9393

@@ -440,19 +440,19 @@ string data in all Python versions.
440440
.. function:: ensure_binary(s, encoding='utf-8', errors='strict')
441441

442442
Coerce *s* to :data:`binary_type`. *encoding*, *errors* are the same as
443-
:meth:`py3:str.encode`
443+
:meth:`py3:str.encode`.
444444

445445

446446
.. function:: ensure_str(s, encoding='utf-8', errors='strict')
447447

448448
Coerce *s* to ``str``. *encoding*, *errors* are the same as
449-
:meth:`py3:str.encode`
449+
:meth:`py3:str.encode`.
450450

451451

452452
.. function:: ensure_text(s, encoding='utf-8', errors='strict')
453453

454454
Coerce *s* to :data:`text_type`. *encoding*, *errors* are the same as
455-
:meth:`py3:bytes.decode`
455+
:meth:`py3:bytes.decode`.
456456

457457

458458
.. data:: StringIO
@@ -568,7 +568,7 @@ functionality; its structure mimics the structure of the Python 3
568568
this problem for some applications by pretending attributes on unimportable
569569
modules do not exist. This hack does not work in every case, though. If you are
570570
encountering problems with the lazy modules and don't use any from imports
571-
directly from ``six.moves`` modules, you can workaround the issue by removing
571+
directly from ``six.moves`` modules, you can work around the issue by removing
572572
the six proxy modules::
573573

574574
d = [name for name in sys.modules if name.startswith("six.moves.")]
@@ -864,7 +864,7 @@ It is possible to add additional names to the :mod:`six.moves` namespace.
864864

865865

866866
Instances of the following classes can be passed to :func:`add_move`. Neither
867-
have any public members.
867+
has any public members.
868868

869869

870870
.. class:: MovedModule(name, old_mod, new_mod)

0 commit comments

Comments
 (0)