{"id":13734626,"url":"https://github.com/pycqa/flake8-docstrings","last_synced_at":"2025-04-13T11:42:34.267Z","repository":{"id":2567816,"uuid":"38896310","full_name":"PyCQA/flake8-docstrings","owner":"PyCQA","description":"Integration of pydocstyle and flake8 for combined linting and reporting","archived":false,"fork":false,"pushed_at":"2025-03-31T20:52:16.000Z","size":144,"stargazers_count":158,"open_issues_count":3,"forks_count":18,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-06T08:07:43.144Z","etag":null,"topics":["docstrings","flake8","flake8-extension","flake8-plugin","pydocstyle"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PyCQA.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-10T18:39:48.000Z","updated_at":"2025-03-05T11:09:25.000Z","dependencies_parsed_at":"2023-07-05T18:18:02.828Z","dependency_job_id":"d5da3072-5285-45fb-b15b-9ed80abd5223","html_url":"https://github.com/PyCQA/flake8-docstrings","commit_stats":{"total_commits":139,"total_committers":21,"mean_commits":6.619047619047619,"dds":0.6402877697841727,"last_synced_commit":"2e2f1b2700dafe36115c2e2efc3ac7d66aa4ee3e"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fflake8-docstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fflake8-docstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fflake8-docstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyCQA%2Fflake8-docstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyCQA","download_url":"https://codeload.github.com/PyCQA/flake8-docstrings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248709711,"owners_count":21149181,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docstrings","flake8","flake8-extension","flake8-plugin","pydocstyle"],"created_at":"2024-08-03T03:00:58.237Z","updated_at":"2025-04-13T11:42:34.244Z","avatar_url":"https://github.com/PyCQA.png","language":"Python","funding_links":[],"categories":["Docstrings"],"sub_categories":[],"readme":"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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycqa%2Fflake8-docstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpycqa%2Fflake8-docstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycqa%2Fflake8-docstrings/lists"}