Small doc updates

edschofield · edschofield · commit c0809f50a3b0 · 2014-12-15T09:04:56.000+11:00
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Python Charmers Pty Ltd, Australia
+Copyright (c) 2013-2015 Python Charmers Pty Ltd, Australia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.rst b/README.rst
@@ -13,7 +13,7 @@ ports of features from Python 3 and 2. It also comes with ``futurize`` and
 either Py2 or Py3 code easily to support both Python 2 and 3 in a single
 clean Py3-style codebase, module by module.
 
-Notable projects that use ``python-future`` for Python 3/2 compatibility
+Notable projects that use ``python-future`` for Python 2/3 compatibility
 are `Mezzanine <http://mezzanine.jupo.org/>`_ and `ObsPy
 <http://obspy.org>`_.
 
@@ -149,17 +149,20 @@ interface works like this:
     from future import standard_library
     standard_library.install_aliases()
 
-    # Then, as usual:
-    from itertools import filterfalse
+    # Then, for example:
+    from itertools import filterfalse, zip_longest
     from urllib.request import urlopen
+    from collections import Counter, OrderedDict   # backported to Py2.6
+    from collections import UserDict, UserList, UserString
+    from subprocess import getoutput, getstatusoutput
 
 
 Automatic conversion to Py2/3-compatible code
 ---------------------------------------------
 
 ``python-future`` comes with two scripts called ``futurize`` and
 ``pasteurize`` to aid in making Python 2 code or Python 3 code compatible with
-both platforms (Py2&3). It is based on 2to3 and uses fixers from ``lib2to3``,
+both platforms (Py2/3). It is based on 2to3 and uses fixers from ``lib2to3``,
 ``lib3to2``, and ``python-modernize``, as well as custom fixers.
 
 ``futurize`` passes Python 2 code through all the appropriate fixers to turn it
@@ -261,7 +264,7 @@ Licensing
 
 :Author:  Ed Schofield
 
-:Copyright: 2013-2014 Python Charmers Pty Ltd, Australia.
+:Copyright: 2013-2015 Python Charmers Pty Ltd, Australia.
 
 :Sponsor: Python Charmers Pty Ltd, Australia, and Python Charmers Pte
           Ltd, Singapore. http://pythoncharmers.com
diff --git a/docs/automatic_conversion.rst b/docs/automatic_conversion.rst
@@ -1,11 +1,11 @@
 .. _automatic-conversion:
 
-Automatic conversion to Py2&3
+Automatic conversion to Py2/3
 =============================
 
 The ``future`` source tree includes scripts called ``futurize`` and
 ``pasteurize`` to aid in making Python 2 code or Python 3 code compatible with
-both platforms (Py2&3) using the :mod:`future` module. These are based on
+both platforms (Py2/3) using the :mod:`future` module. These are based on
 ``lib2to3`` and use fixers from ``2to3``, ``3to2``, and ``python-modernize``.
 
 ``futurize`` passes Python 2 code through all the appropriate fixers to turn it
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -5,6 +5,67 @@ Changes in previous versions
 
 Changes in the most recent two versions are here: :ref:`whats-new`.
 
+.. _whats-new-0.13.x:
+
+Changes in version 0.13.1
+=========================
+
+This is a bug-fix release:
+
+- Fix (multiple) inheritance of ``future.builtins.object`` with metaclasses (issues #91 and #96)
+- Fix ``futurize``'s refactoring of ``urllib`` imports (issue #94)
+- Fix ``futurize --all-imports`` (issue #101)
+- Fix ``futurize --output-dir`` logging (issue #102)
+- Doc formatting fix (issues #98, 100)
+
+
+Changes in version 0.13
+=======================
+
+This is mostly a clean-up release. It adds some small new compatibility features
+and fixes several bugs.
+
+Deprecations
+------------
+
+The following unused internal modules are now deprecated. They will be removed in a
+future release:
+
+- ``future.utils.encoding`` and ``future.utils.six``.
+
+(Issue #80). See `here <http://fedoraproject.org/wiki/Packaging:No_Bundled_Libraries>`_
+for the rationale for unbundling them.
+
+
+New features
+------------
+
+- Docs: Add :ref:`compatible-idioms` from Ed Schofield's PyConAU 2014 talk.
+- Add ``newint.to_bytes()`` and ``newint.from_bytes()`` (issue #85)
+- Add ``future.utils.raise_from`` as an equivalent to Py3's ``raise ... from
+  ...`` syntax (issue #86).
+- Add ``past.builtins.oct()`` function.
+- Add backports for Python 2.6 of ``subprocess.check_output()``,
+  ``itertools.combinations_with_replacement()``, and ``functools.cmp_to_key()``.
+
+Bug fixes
+---------
+
+- Use a private logger instead of the global logger in
+  ``future.standard_library`` (issue #82). This restores compatibility of the
+  standard library hooks with ``flask`` (issue #79).
+- Stage 1 of ``futurize`` no longer renames ``next`` methods to ``__next__``
+  (issue #81). It still converts ``obj.next()`` method calls to
+  ``next(obj)`` correctly.
+- Prevent introduction of a second set of parentheses in ``print()`` calls in
+  some further cases.
+- Fix isinstance checks for subclasses of future types (issue #89).
+- Be explicit about encoding file contents as UTF-8 in unit tests (issue #63).
+  Useful for building RPMs and in other environments where ``LANG=C``.
+- Fix for 3-argument ``pow(x, y, z)`` with ``newint`` arguments (issue #87).
+  (Thanks to @str4d).
+
+
 .. _whats-new-0.12.4:
 
 Changes in version 0.12.4
@@ -116,7 +177,7 @@ with tools like ``py2exe``.
 -------------------------------------------------------------------------
 
 There is a new ``future.types.newobject`` base class (available as
-``future.builtins.object``) that can streamline Py3/2 compatible code by
+``future.builtins.object``) that can streamline Py2/3 compatible code by
 providing fallback Py2-compatible special methods for its subclasses. It
 currently provides ``next()`` and ``__nonzero__()`` as fallback methods on Py2
 when its subclasses define the corresponding Py3-style ``__next__()`` and
@@ -704,6 +765,15 @@ deprecated.
 Summary of all changes
 ======================
 
+v0.14.3:
+  * Bug fixes
+
+v0.14.2:
+  * Bug fixes
+
+v0.14.1:
+  * Bug fixes
+
 v0.14:
   * New top-level ``builtins`` package on Py2 for cleaner imports. Equivalent to
     ``future.builtins``
diff --git a/docs/compatible_idioms.rst b/docs/compatible_idioms.rst
@@ -3,7 +3,7 @@
 Cheat Sheet: Writing Python 2-3 compatible code
 ===============================================
 
--  **Copyright (c):** 2013-2014 Python Charmers Pty Ltd, Australia.
+-  **Copyright (c):** 2013-2015 Python Charmers Pty Ltd, Australia.
 -  **Author:** Ed Schofield.
 -  **Licence:** Creative Commons Attribution.
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,7 +51,7 @@
 
 # General information about the project.
 project = u'Python-Future'
-copyright = u'2013-2014, Python Charmers Pty Ltd, Australia'
+copyright = u'2013-2015, Python Charmers Pty Ltd, Australia'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
diff --git a/docs/credits.rst b/docs/credits.rst
@@ -8,7 +8,7 @@ Licence
 The software is distributed under an MIT licence. The text is as follows
 (from ``LICENSE.txt``)::
 
-    Copyright (c) 2013-2014 Python Charmers Pty Ltd, Australia
+    Copyright (c) 2013-2015 Python Charmers Pty Ltd, Australia
     
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal
diff --git a/docs/futurize.rst b/docs/futurize.rst
@@ -1,6 +1,6 @@
 .. _forwards-conversion:
 
-``futurize``: Py2 to Py2&3
+``futurize``: Py2 to Py2/3
 --------------------------
 
 .. include:: futurize_overview.rst
diff --git a/docs/futurize_cheatsheet.rst b/docs/futurize_cheatsheet.rst
@@ -1,6 +1,6 @@
 .. _futurize_cheatsheet:
 
-``futurize`` quick-start: automatic conversion from Py2 to Py2&3
+``futurize`` quick-start: automatic conversion from Py2 to Py2/3
 ================================================================
 
 Instructions and notes on converting code from supporting only Python 2 to
diff --git a/docs/notebooks/Writing Python 2-3 compatible code.ipynb b/docs/notebooks/Writing Python 2-3 compatible code.ipynb
@@ -20,7 +20,7 @@
      "cell_type": "markdown",
      "metadata": {},
      "source": [
-      "- **Copyright (c):** 2013-2014 Python Charmers Pty Ltd, Australia.\n",
+      "- **Copyright (c):** 2013-2015 Python Charmers Pty Ltd, Australia.\n",
       "- **Author:** Ed Schofield.\n",
       "- **Licence:** Creative Commons Attribution.\n",
       "\n",
@@ -3004,4 +3004,4 @@
    "metadata": {}
   }
  ]
-}
+}
diff --git a/docs/pasteurize.rst b/docs/pasteurize.rst
@@ -1,6 +1,6 @@
 .. _backwards-conversion:
 
-``pasteurize``: Py3 to Py2&3
+``pasteurize``: Py3 to Py2/3
 ----------------------------
 
 Running ``pasteurize -w mypy3module.py`` turns this Python 3 code::
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -42,7 +42,7 @@ The easiest way is to start each new module with these lines::
 Then write standard Python 3 code. The :mod:`future` package will
 provide support for running your code on Python 2.6 and 2.7 mostly unchanged.
 
-- For explicit import forms, see :ref:`imports`.
+- For explicit import forms, see :ref:`explicit-imports`.
 - For more details, see :ref:`what-else`.
 - For a cheat sheet, see :ref:`compatible-idioms`.
 
diff --git a/docs/whatsnew.rst b/docs/whatsnew.rst
@@ -14,6 +14,7 @@ This is a bug-fix release:
 - Add signed support for ``newint.to_bytes()`` (issue #128)
 - Fix ``OrderedDict.clear()`` on Py2.6 (issue #125)
 - Improve ``newrange``: equality and slicing, start/stop/step properties, refactoring (issues #129, #130)
+- Minor doc updates
 
 What's new in version 0.14.2
 ============================
@@ -42,8 +43,8 @@ This is a minor bug-fix release:
   exists on Py2 (issue #109)
 
 
-What's new in version 0.14.0
-============================
+What's new in version 0.14
+==========================
 
 This is a major new release that offers a cleaner interface for most imports in
 Python 2/3 compatible code.
@@ -59,7 +60,7 @@ Instead of this interface::
     ...     import tkinter.dialog
     ...     # etc.
 
-you can now use the following interface for Python 2/3 compatible code::
+you can now use the following interface for much Python 2/3 compatible code::
 
     >>> # Alias for future.builtins on Py2:
     >>> from builtins import str, open, range, dict
@@ -131,68 +132,7 @@ The following internal functions have been deprecated and will be removed in a f
 - ``future.standard_library.scrub_future_sys_modules``
 
 
-.. _whats-new-0.13.x:
-
-What's new in version 0.13.1
-============================
-
-This is a bug-fix release:
-
-- Fix (multiple) inheritance of ``future.builtins.object`` with metaclasses (issues #91 and #96)
-- Fix ``futurize``'s refactoring of ``urllib`` imports (issue #94)
-- Fix ``futurize --all-imports`` (issue #101)
-- Fix ``futurize --output-dir`` logging (issue #102)
-- Doc formatting fix (issues #98, 100)
-
-
-What's new in version 0.13
-==========================
-
-This is mostly a clean-up release. It adds some small new compatibility features
-and fixes several bugs.
-
-Deprecations
-------------
-
-The following unused internal modules are now deprecated. They will be removed in a
-future release:
-
-- ``future.utils.encoding`` and ``future.utils.six``.
-
-(Issue #80). See `here <http://fedoraproject.org/wiki/Packaging:No_Bundled_Libraries>`_
-for the rationale for unbundling them.
-
-
-New features
-------------
-
-- Docs: Add :ref:`compatible-idioms` from Ed Schofield's PyConAU 2014 talk.
-- Add ``newint.to_bytes()`` and ``newint.from_bytes()`` (issue #85)
-- Add ``future.utils.raise_from`` as an equivalent to Py3's ``raise ... from
-  ...`` syntax (issue #86).
-- Add ``past.builtins.oct()`` function.
-- Add backports for Python 2.6 of ``subprocess.check_output()``,
-  ``itertools.combinations_with_replacement()``, and ``functools.cmp_to_key()``.
-
-Bug fixes
----------
-
-- Use a private logger instead of the global logger in
-  ``future.standard_library`` (issue #82). This restores compatibility of the
-  standard library hooks with ``flask`` (issue #79).
-- Stage 1 of ``futurize`` no longer renames ``next`` methods to ``__next__``
-  (issue #81). It still converts ``obj.next()`` method calls to
-  ``next(obj)`` correctly.
-- Prevent introduction of a second set of parentheses in ``print()`` calls in
-  some further cases.
-- Fix isinstance checks for subclasses of future types (issue #89).
-- Be explicit about encoding file contents as UTF-8 in unit tests (issue #63).
-  Useful for building RPMs and in other environments where ``LANG=C``.
-- Fix for 3-argument ``pow(x, y, z)`` with ``newint`` arguments (issue #87).
-  (Thanks to @str4d).
-
-
 Previous versions
 =================
 
-See the :ref:`whats-old` for versions prior to v0.13.
+See :ref:`whats-old` for versions prior to v0.14.
diff --git a/futurize.py b/futurize.py
@@ -13,7 +13,7 @@
 
 Licensing
 ---------
-Copyright 2013 Python Charmers Pty Ltd, Australia.
+Copyright 2013-2015 Python Charmers Pty Ltd, Australia.
 The software is distributed under an MIT licence. See LICENSE.txt.
 """
 
diff --git a/pasteurize.py b/pasteurize.py
@@ -12,7 +12,7 @@
 
 Licensing
 ---------
-Copyright 2013-2014 Python Charmers Pty Ltd, Australia.
+Copyright 2013-2015 Python Charmers Pty Ltd, Australia.
 The software is distributed under an MIT licence. See LICENSE.txt.
 """
 
diff --git a/src/future/__init__.py b/src/future/__init__.py
diff --git a/src/libfuturize/main.py b/src/libfuturize/main.py
diff --git a/src/libpasteurize/main.py b/src/libpasteurize/main.py
diff --git a/src/past/__init__.py b/src/past/__init__.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2013-2014 Python Charmers Pty Ltd, Australia`
	`1`	`+Copyright (c) 2013-2015 Python Charmers Pty Ltd, Australia`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy`
`4`	`4`	`of this software and associated documentation files (the "Software"), to deal`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"cell_type": "markdown",`
`21`	`21`	`"metadata": {},`
`22`	`22`	`"source": [`
`23`		`- "- Copyright (c): 2013-2014 Python Charmers Pty Ltd, Australia.\n",`
	`23`	`+ "- Copyright (c): 2013-2015 Python Charmers Pty Ltd, Australia.\n",`
`24`	`24`	`"- Author: Ed Schofield.\n",`
`25`	`25`	`"- Licence: Creative Commons Attribution.\n",`
`26`	`26`	`"\n",`
`@@ -3004,4 +3004,4 @@`
`3004`	`3004`	`"metadata": {}`
`3005`	`3005`	`}`
`3006`	`3006`	`]`
`3007`		`-}`
	`3007`	`+}`