summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris Withers <chris@simplistix.co.uk>2018-11-29 07:54:45 +0000
committerGitHub <noreply@github.com>2018-11-29 07:54:45 +0000
commitcec8afe33a6efeb12b0e9799788f7c193f9e62ac (patch)
tree8260379831978856434a8943f2d754e4caa6a5e7 /docs
parent34e5101e1411d19f51f5f9c5c88401e6262c2641 (diff)
parent27cd14718523951a3a7663d42b9cd6f5139768e1 (diff)
downloadmock-cec8afe33a6efeb12b0e9799788f7c193f9e62ac.tar.gz
Merge branch 'master' into pypi
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py1
-rw-r--r--docs/index.txt24
2 files changed, 12 insertions, 13 deletions
diff --git a/docs/conf.py b/docs/conf.py
index d32357d..6368a01 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,7 +33,6 @@ import os
import sys
import mock
from mock import * # yeah, I know :-/
-import unittest2
import __main__
if os.getcwd() not in sys.path:
diff --git a/docs/index.txt b/docs/index.txt
index 082f757..66a1a09 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -1,6 +1,6 @@
-====================================
+===================================
Mock - Mocking and Testing Library
-====================================
+===================================
:Version: |release|
:Date: |today|
@@ -45,12 +45,12 @@ the newest features from the latest release of Python available for all
Pythons.
The ``mock`` package contains a rolling backport of the standard library mock
-code compatible with Python 2.7 and 3.3 and up.
+code compatible with Python 2.7 and 3.4 and up.
-* Python 2.6 is supported by mock 2.0.0 and below.
+* Python 2.6 and 3.3 are supported by mock 2.0.0 and below.
* Python 3.2 is supported by mock 1.3.0 and below - with pip no longer
-supporting 3.2, we cannot test against that version anymore.
+ supporting 3.2, we cannot test against that version anymore.
Please see the standard library documentation for usage details.
@@ -90,7 +90,7 @@ unpacking run:
Bug Reports
+++++++++++
-Mock uses `unittest2 <https://pypi.org/project/unittest2/>`_ for its own
+Mock uses `unittest <https://docs.python.org/3/library/unittest.html>`_ for its own
Issues with the backport process, such as compatibility with a particular
Python, should be reported to the `bug tracker
<https://github.com/testing-cabal/mock/issues>`_. Feature requests and issues
@@ -121,20 +121,20 @@ Maintainer Notes
++++++++++++++++
Development
-===========
+-----------
Checkout from git (see :ref:`installing`) and submit pull requests.
Committers can just push as desired: since all semantic development takes
place in cPython, the backport process is as lightweight as we can make it.
-mock is CI tested using Travis-CI on Python versions 2.7, 3.3, 3.4,
-3.5, nightly Python 3 builds, pypy, pypy3. Jython support is desired, if
+mock is CI tested using Travis-CI on Python versions 2.7, 3.4,
+3.5, 3.6, nightly Python 3 builds, pypy, pypy3. Jython support is desired, if
someone could contribute a patch to .travis.yml to support it that would be
excellent.
Releasing
-=========
+---------
NB: please use semver. Bump the major component on API breaks, minor on all
non-bugfix changes, patch on bugfix only changes.
@@ -144,13 +144,13 @@ non-bugfix changes, patch on bugfix only changes.
Backporting rules
-=================
+-----------------
isinstance checks in cPython to ``type`` need to check ``ClassTypes``.
Code calling ``obj.isidentifier`` needs to change to ``_isidentifier(obj)``.
Backporting process
-===================
+-------------------
1. Patch your git am with `my patch <https://github.com/rbtcollins/git>`_.
2. Install the applypatch-transform hook from tools/ to your .git hooks dir.