diff options
| author | Georg Brandl <georg@python.org> | 2010-01-17 19:21:04 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-01-17 19:21:04 +0100 |
| commit | 1bce0d7e6afa7afd0237df2ef75b823bb8e21e82 (patch) | |
| tree | 0b66c66d6cb58b62a10c9cb661d46e81a8f69de0 | |
| parent | 538886ab94072fd837c9f0d2475cf7eee43ec47c (diff) | |
| download | sphinx-git-1bce0d7e6afa7afd0237df2ef75b823bb8e21e82.tar.gz | |
Fix some XXXes.
| -rw-r--r-- | doc/builders.rst | 8 | ||||
| -rw-r--r-- | doc/rest.rst | 2 | ||||
| -rw-r--r-- | tests/root/conf.py | 3 | ||||
| -rw-r--r-- | tests/test_coverage.py | 3 | ||||
| -rw-r--r-- | utils/pylintrc | 2 |
5 files changed, 8 insertions, 10 deletions
diff --git a/doc/builders.rst b/doc/builders.rst index b543eb5f1..4beb5bfff 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -298,7 +298,9 @@ The special files are located in the root output directory. They are: ``environment.pickle`` The build environment. This is always a pickle file, independent of the builder and a copy of the environment that was used when the builder was - started. (XXX: document common members) + started. - Unlike the other pickle files this pickle file requires that the sphinx - module is available on unpickling. + .. todo:: Document common members. + + Unlike the other pickle files this pickle file requires that the ``sphinx`` + package is available on unpickling. diff --git a/doc/rest.rst b/doc/rest.rst index 273bd31fd..87c9f80c5 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -340,5 +340,3 @@ There are some problems one commonly runs into while authoring reST documents: * **No nested inline markup:** Something like ``*see :func:`foo`*`` is not possible. - -.. XXX more? diff --git a/tests/root/conf.py b/tests/root/conf.py index d8e5de644..71f48ce66 100644 --- a/tests/root/conf.py +++ b/tests/root/conf.py @@ -51,8 +51,7 @@ latex_additional_files = ['svgimg.svg'] value_from_conf_py = 84 coverage_c_path = ['special/*.h'] -# XXX cfunction? -coverage_c_regexes = {'cfunction': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'} +coverage_c_regexes = {'function': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'} autosummary_generate = ['autosummary'] diff --git a/tests/test_coverage.py b/tests/test_coverage.py index 94b45eb8e..1262ebf5b 100644 --- a/tests/test_coverage.py +++ b/tests/test_coverage.py @@ -36,8 +36,7 @@ def test_build(app): undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').text()) assert len(undoc_c) == 1 # the key is the full path to the header file, which isn't testable - # XXX this should fail right now - assert undoc_c.values()[0] == [('cfunction', 'Py_SphinxTest')] + assert undoc_c.values()[0] == [('function', 'Py_SphinxTest')] assert 'test_autodoc' in undoc_py assert 'funcs' in undoc_py['test_autodoc'] diff --git a/utils/pylintrc b/utils/pylintrc index 2552a12c8..cf71db595 100644 --- a/utils/pylintrc +++ b/utils/pylintrc @@ -273,7 +273,7 @@ ignore-docstrings=yes # checks for: -# * warning notes in the code like FIXME, XXX +# * warning notes in the code # * PEP 263: source code with non ascii character but no encoding declaration # [MISCELLANEOUS] |