Merge pull request #173 from Nurdok/pep257-to-pydocstyle

Renaming to pydocstyle

Author: Nurdok

LICENSE-MIT

@@ -1,4 +1,5 @@
 Copyright (c) 2012 GreenSteam, <http://greensteam.dk/>
+Copyright (c) 2014-2016 Amir Rachum, <http://amir.rachum.com/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.rst

@@ -1,16 +1,21 @@
-PEP 257 docstring style checker
-===========================================================
+pydocstyle - docstring style checker
+====================================
 
-**pep257** is a static analysis tool for checking
-compliance with Python `PEP 257
-<http://www.python.org/dev/peps/pep-0257/>`_.
+(formerly pep257)
+
+**pydocstyle** is a static analysis tool for checking compliance with Python
+docstring conventions.
+
+**pydocstyle** supports most of
+`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
+should not be considered a reference implementation.
 
 The framework for checking docstring style is flexible, and
 custom checks can be easily added, for example to cover
 NumPy `docstring conventions
 <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_.
 
-**pep257** supports Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.
+**pydocstyle** supports Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.
 
 Quick Start
 -----------
@@ -20,14 +25,14 @@ Install
 
 .. code::
 
-    pip install pep257
+    pip install pydocstyle
 
 Run
 ^^^
 
 .. code::
 
-    $ pep257 test.py
+    $ pydocstyle test.py
     test.py:18 in private nested class `meta`:
             D101: Docstring missing
     test.py:22 in public method `method`:
@@ -38,15 +43,15 @@ Run
 Links
 -----
 
-.. image:: https://travis-ci.org/GreenSteam/pep257.svg?branch=master
-    :target: https://travis-ci.org/GreenSteam/pep257
+.. image:: https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master
+    :target: https://travis-ci.org/PyCQA/pydocstyle
 
-.. image:: https://readthedocs.org/projects/pep257/badge/?version=latest
-    :target: https://readthedocs.org/projects/pep257/?badge=latest
+.. image:: https://readthedocs.org/projects/pydocstyle/badge/?version=latest
+    :target: https://readthedocs.org/projects/pydocstyle/?badge=latest
     :alt: Documentation Status
 
-* `Read the full documentation here <http://pep257.readthedocs.org>`_.
+* `Read the full documentation here <http://pydocstyle.readthedocs.org>`_.
 
-* `Fork pep257 on GitHub <http://github.com/GreenSteam/pep257>`_.
+* `Fork pydocstyle on GitHub <http://github.com/PyCQA/pydocstyle>`_.
 
-* `PyPI project page <https://pypi.python.org/pypi/pep257>`_.
+* `PyPI project page <https://pypi.python.org/pypi/pydocstyle>`_.

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# pep257 documentation build configuration file, created by
+# pydocstyle documentation build configuration file, created by
 # sphinx-quickstart on Fri Jan 30 20:30:42 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -48,17 +48,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'pep257'
-copyright = u'2015, Vladimir Keleshev'
+project = u'pydocstyle'
+copyright = u'2016, Amir Rachum'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.5.0'
+version = '1.0.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.5.0'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -181,7 +181,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pep257doc'
+htmlhelp_basename = 'pydocstyledoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -201,8 +201,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'pep257.tex', u'pep257 Documentation',
-   u'Vladimir Keleshev', 'manual'),
+  ('index', 'pydocstyle.tex', u'pydocstyle Documentation',
+   u'Amir Rachum', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -231,8 +231,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pep257', u'pep257 Documentation',
-     [u'Vladimir Keleshev'], 1)
+    ('index', 'pydocstyle', u'pydocstyle Documentation',
+     [u'Amir Rachum'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -245,8 +245,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'pep257', u'pep257 Documentation',
-   u'Vladimir Keleshev', 'pep257', 'One line description of project.',
+  ('index', 'pydocstyle', u'pydocstyle Documentation',
+   u'Amir Rachum', 'pydocstyle', 'Docstring style checker',
    'Miscellaneous'),
 ]
 
@@ -264,11 +264,11 @@
 
 # sphinxcontrib.issuetracker settings
 issuetracker = 'github'
-issuetracker_project = 'GreenSteam/pep257'
+issuetracker_project = 'PyCQA/pydocstyle'
 
 
 def generate_error_code_table():
-    from pep257 import ErrorRegistry
+    from pydocstyle import ErrorRegistry
     with open(os.path.join('snippets', 'error_code_table.rst'), 'wt') as outf:
         outf.write(ErrorRegistry.to_rst())
 

docs/index.rst

@@ -1,14 +1,14 @@
-.. pep257 documentation master file, created by
-   sphinx-quickstart on Fri Jan 30 20:30:42 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+pydocstyle's documentation
+==========================
 
-pep257's documentation
-======================
+(formerly pep257)
 
-**pep257** is a static analysis tool for checking
-compliance with Python `PEP 257
-<http://www.python.org/dev/peps/pep-0257/>`_.
+**pydocstyle** is a static analysis tool for checking compliance with Python
+docstring conventions.
+
+**pydocstyle** supports most of
+`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
+should not be considered a reference implementation.
 
 
 .. include:: quickstart.rst
@@ -28,7 +28,8 @@ Contents:
 Credits
 =======
 
-Created by Vladimir Keleshev.
+pydocstyle is a rename and continuation of pep257, a project created by
+Vladimir Keleshev.
 
 Maintained by Amir Rachum.
 

docs/quickstart.rst

@@ -5,13 +5,13 @@ Quick Start
 
     .. code::
 
-        pip install pep257
+        pip install pydocstyle
 
 2. Run
 
     .. code::
 
-        $ pep257 test.py
+        $ pydocstyle test.py
         test.py:18 in private nested class `meta`:
                 D101: Docstring missing
         test.py:22 in public method `method`:

docs/release_notes.rst

@@ -18,13 +18,22 @@ New Features
 
 Bug Fixes
 
-* Fixed an issue where a ``NameError`` was raised when parsing complex defintions
-  of ``__all__`` (#142, #143).
+* Fixed an issue where a ``NameError`` was raised when parsing complex
+  definitions of ``__all__`` (#142, #143).
 
 * Fixed a bug where D202 was falsely reported when a function with just a
   docstring and no content was followed by a comment (#165).
 
 
+Older Versions
+==============
+
+.. note::
+
+    Versions documented below are before renaming the project from **pep257**
+    to **pydocstyle**.
+
+
 0.7.0 - October 9th, 2015
 -------------------------
 

docs/snippets/cli.rst

@@ -5,13 +5,16 @@ Usage
 
 .. code::
 
-    Usage: pep257 [options] [<file|dir>...]
+    Usage: pydocstyle [options] [<file|dir>...]
 
     Options:
       --version             show program's version number and exit
       -h, --help            show this help message and exit
       -e, --explain         show explanation of each error
       -s, --source          show source for each error
+      -d, --debug           print debug information
+      -v, --verbose         print status information
+      --count               print total number of errors to stdout
       --select=<codes>      choose the basic list of checked errors by specifying
                             which errors to check for (with a list of comma-
                             separated error codes). for example:
@@ -33,9 +36,6 @@ Usage
                             search only dirs that exactly match <pattern> regular
                             expression; default is --match-dir='[^\.].*', which
                             matches all dirs that don't start with a dot
-      -d, --debug           print debug information
-      -v, --verbose         print status information
-      --count               print total number of errors to stdout
 
 
 Return Code

docs/snippets/config.rst

@@ -1,12 +1,24 @@
-``pep257`` supports `ini`-like configuration files. In order for ``pep257`` to
-use it, it must be named ``setup.cfg``, ``tox.ini``, ``.pep257``, or
-``.pep257rc`` and have a ``[pep257]`` section.
-
-When searching for a configuration file, ``pep257`` looks for one of the file
-specified above `in that exact order`. If a configuration file was not found,
-it keeps looking for one up the directory tree until one is found or uses
+``pydocstyle`` supports *ini*-like configuration files.
+In order for ``pydocstyle`` to use it, it must be named one of the following
+options, and have a ``[pydocstyle]`` section.
+
+* ``setup.cfg``
+* ``tox.ini``
+* ``.pydocstyle``
+* ``.pydocstylerc``
+
+When searching for a configuration file, ``pydocstyle`` looks for one of the
+file specified above *in that exact order*. If a configuration file was not
+found,it keeps looking for one up the directory tree until one is found or uses
 the default configuration.
 
+.. deprecated::
+
+    For backwards compatibility purposes, **pydocstyle** supports configuration
+    files named ``.pep257`` and ``.pep257rc``, as well as section header
+    ``[pep257]``. However, these are considered deprecated and support will be
+    removed in version 2.0.0.
+
 Available Options
 #################
 
@@ -26,14 +38,14 @@ See the :ref:`cli_usage` section for more information.
 Inheritance
 ###########
 
-By default, when finding a configuration file, ``pep257`` tries to inherit
+By default, when finding a configuration file, ``pydocstyle`` tries to inherit
 the parent directory's configuration and merge them to the local ones.
 
 The merge process is as follows:
 
 * If one of ``select``, ``ignore`` or ``convention`` was specified in the child
   configuration - Ignores the parent configuration and set the new error codes
-  to check. Othewise, Simply copies the parent checked error codes.
+  to check. Otherwise, simply copies the parent checked error codes.
 * If ``add-ignore`` or ``add-select`` were specified, adds or removes the
   specified error codes from the checked error codes list.
 * If ``match`` or ``match-dir`` were specified - use them. Otherwise, use the
@@ -54,7 +66,7 @@ Example
 
 .. code::
 
-    [pep257]
+    [pydocstyle]
     inherit = false
     ignore = D100,D203,D405
     match = *.py

docs/snippets/install.rst

@@ -1,6 +1,9 @@
-Use `pip <http://pip-installer.org>`_ or easy_install::
+Use `pip <http://pip-installer.org>`_ or easy_install:
 
-    pip install pep257
 
-Alternatively, you can use ``pep257.py`` source file
-directly--it is self-contained.
+.. code::
+
+    pip install pydocstyle
+
+Alternatively, you can use ``pydocstyle.py`` source file
+directly - it is self-contained.

requirements.txt

@@ -0,0 +1,2 @@
+-r requirements/docs.txt
+-r requirements/tests.txt