Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit 6de6d93

Browse files
sambhavNurdok
authored andcommitted
Add an initial Google convention (#357)
* Add an initial Google convention Sources for docstring convention: [Google Style Guide](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) and [Napoleon Google Style Guide](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) Rationale for exclusions of errors: D203: Multiple examples with class docstrings without blank line. D204: Same as above. D213: All multiline summaries start immediately after the triple quotes. D215: N/A no underlines. D400: First line can end with "period, question mark, or exclamation point". D401: Style guide explicitly says not to use imperative mood and use descriptive mood. D404: Clearly allowed WRT to the above. There is also an example using "This". D406: Section names end with a colon. D407: N/A no underlines. D408: N/A no underlines. D409: N/A no underlines. * Add D415: Google style summary end char checker. This commit adds error code D415 which allows for Google style end char checking (".", "?", "!"). * Add basic google style section checks * Add support for D417 missing argument docstrings pydocstyle now supports checking for missing function arguments from docstrings.
1 parent 2549847 commit 6de6d93

File tree

7 files changed

+406
-99
lines changed

7 files changed

+406
-99
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*.py[co]
2+
__pycache__
23

34
# Vim
45
*.swp
@@ -46,6 +47,7 @@ docs/_*
4647
# virtualenv
4748
venv/
4849
.venvs/
50+
.venv/
4951

5052
# generated rst
5153
docs/snippets/error_code_table.rst

0 commit comments

Comments
 (0)