flake8-docstrings


Nameflake8-docstrings JSON
Version 1.7.0 PyPI version JSON
download
home_pagehttps://github.com/pycqa/flake8-docstrings
SummaryExtension for flake8 which uses pydocstyle to check docstrings
upload_time2023-01-25 14:27:13
maintainerIan Cordasco
docs_urlNone
authorSimon ANDRÉ
requires_python>=3.7
licenseMIT
keywords pep 257 pydocstyle pep257 docstrings flake8
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            flake8-docstrings
=================

A simple module that adds an extension for the fantastic pydocstyle_ tool to
flake8_.

Simply install this extension::

    pip install flake8-docstrings

and run flake8.

You can set the pydocstyle convention_ at the command line using::

    $ flake8 --docstring-convention numpy ...

Or, adding ``docstring-convention=numpy`` to your flake8 configuration file.
The available set of conventions depends on the version of pydocstyle installed.
The default is ``pep257``, pydocstyle v2.0.0 added ``numpy`` (for the numpydoc
standard), while pydocstyle v4.0.0 added ``google``.

In order to choose a custom list of error codes, use the special value
``docstring-convention=all``, then choose the codes you want checked using
flake8_'s built-in ``--ignore``/``--select`` functionality.

Report any issues on our `bug tracker`_.

.. _pydocstyle: https://github.com/pycqa/pydocstyle
.. _flake8: https://github.com/pycqa/flake8
.. _convention: http://www.pydocstyle.org/en/latest/error_codes.html#default-conventions
.. _bug tracker: https://github.com/pycqa/flake8-docstrings/issues

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pycqa/flake8-docstrings",
    "name": "flake8-docstrings",
    "maintainer": "Ian Cordasco",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "graffatcolmingov@gmail.com",
    "keywords": "PEP 257,pydocstyle,pep257,docstrings,flake8",
    "author": "Simon ANDR\u00c9",
    "author_email": "sandre@anybox.fr",
    "download_url": "https://files.pythonhosted.org/packages/93/24/f839e3a06e18f4643ccb81370909a497297909f15106e6af2fecdef46894/flake8_docstrings-1.7.0.tar.gz",
    "platform": null,
    "description": "flake8-docstrings\n=================\n\nA simple module that adds an extension for the fantastic pydocstyle_ tool to\nflake8_.\n\nSimply install this extension::\n\n    pip install flake8-docstrings\n\nand run flake8.\n\nYou can set the pydocstyle convention_ at the command line using::\n\n    $ flake8 --docstring-convention numpy ...\n\nOr, adding ``docstring-convention=numpy`` to your flake8 configuration file.\nThe available set of conventions depends on the version of pydocstyle installed.\nThe default is ``pep257``, pydocstyle v2.0.0 added ``numpy`` (for the numpydoc\nstandard), while pydocstyle v4.0.0 added ``google``.\n\nIn order to choose a custom list of error codes, use the special value\n``docstring-convention=all``, then choose the codes you want checked using\nflake8_'s built-in ``--ignore``/``--select`` functionality.\n\nReport any issues on our `bug tracker`_.\n\n.. _pydocstyle: https://github.com/pycqa/pydocstyle\n.. _flake8: https://github.com/pycqa/flake8\n.. _convention: http://www.pydocstyle.org/en/latest/error_codes.html#default-conventions\n.. _bug tracker: https://github.com/pycqa/flake8-docstrings/issues\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Extension for flake8 which uses pydocstyle to check docstrings",
    "version": "1.7.0",
    "split_keywords": [
        "pep 257",
        "pydocstyle",
        "pep257",
        "docstrings",
        "flake8"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f7d76a278fa43250441ed9300c344f889c7fb1817080c8fb8996b840bf421c2",
                "md5": "4984d55b8984fc3d358c47fa6858824e",
                "sha256": "51f2344026da083fc084166a9353f5082b01f72901df422f74b4d953ae88ac75"
            },
            "downloads": -1,
            "filename": "flake8_docstrings-1.7.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4984d55b8984fc3d358c47fa6858824e",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 4994,
            "upload_time": "2023-01-25T14:27:12",
            "upload_time_iso_8601": "2023-01-25T14:27:12.320513Z",
            "url": "https://files.pythonhosted.org/packages/3f/7d/76a278fa43250441ed9300c344f889c7fb1817080c8fb8996b840bf421c2/flake8_docstrings-1.7.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9324f839e3a06e18f4643ccb81370909a497297909f15106e6af2fecdef46894",
                "md5": "776d8ea9284e828d93f944bcd8286240",
                "sha256": "4c8cc748dc16e6869728699e5d0d685da9a10b0ea718e090b1ba088e67a941af"
            },
            "downloads": -1,
            "filename": "flake8_docstrings-1.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "776d8ea9284e828d93f944bcd8286240",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 5995,
            "upload_time": "2023-01-25T14:27:13",
            "upload_time_iso_8601": "2023-01-25T14:27:13.903142Z",
            "url": "https://files.pythonhosted.org/packages/93/24/f839e3a06e18f4643ccb81370909a497297909f15106e6af2fecdef46894/flake8_docstrings-1.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-25 14:27:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "pycqa",
    "github_project": "flake8-docstrings",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "flake8-docstrings"
}
        
Elapsed time: 0.03187s