docstringify 0.1.0__tar.gz → 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. {docstringify-0.1.0 → docstringify-0.1.1}/.github/workflows/ci.yml +3 -0
  2. {docstringify-0.1.0 → docstringify-0.1.1}/.pre-commit-hooks.yaml +1 -1
  3. {docstringify-0.1.0 → docstringify-0.1.1}/PKG-INFO +6 -6
  4. {docstringify-0.1.0 → docstringify-0.1.1}/README.md +3 -3
  5. {docstringify-0.1.0 → docstringify-0.1.1}/pyproject.toml +2 -2
  6. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/__init__.py +1 -1
  7. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/PKG-INFO +6 -6
  8. {docstringify-0.1.0 → docstringify-0.1.1}/.github/dependabot.yml +0 -0
  9. {docstringify-0.1.0 → docstringify-0.1.1}/.github/release.yml +0 -0
  10. {docstringify-0.1.0 → docstringify-0.1.1}/.github/workflows/pypi-publish.yml +0 -0
  11. {docstringify-0.1.0 → docstringify-0.1.1}/.gitignore +0 -0
  12. {docstringify-0.1.0 → docstringify-0.1.1}/.pre-commit-config.yaml +0 -0
  13. {docstringify-0.1.0 → docstringify-0.1.1}/LICENSE +0 -0
  14. {docstringify-0.1.0 → docstringify-0.1.1}/setup.cfg +0 -0
  15. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/__main__.py +0 -0
  16. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/cli.py +0 -0
  17. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/components.py +0 -0
  18. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/converters/__init__.py +0 -0
  19. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/converters/base.py +0 -0
  20. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/converters/numpydoc.py +0 -0
  21. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/visitor.py +0 -0
  22. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/SOURCES.txt +0 -0
  23. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/dependency_links.txt +0 -0
  24. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/entry_points.txt +0 -0
  25. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/requires.txt +0 -0
  26. {docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/top_level.txt +0 -0
{docstringify-0.1.0 → docstringify-0.1.1}/.github/workflows/ci.yml RENAMED
@@ -62,3 +62,6 @@ jobs:
62
62
 
63
63
  - name: Install testing dependencies
64
64
  run: python -m pip install '.[dev]'
65
+
66
+ - name: Validate pre-commit hook
67
+ run: pre-commit try-repo . docstringify
{docstringify-0.1.0 → docstringify-0.1.1}/.pre-commit-hooks.yaml RENAMED
@@ -4,5 +4,5 @@
4
4
  Flag missing docstrings and, optionally, generate them from signatures and type annotations.
5
5
  entry: docstringify
6
6
  language: python
7
- serial: true
7
+ require_serial: true
8
8
  types: [python]
{docstringify-0.1.0 → docstringify-0.1.1}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: docstringify
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
5
5
  Author-email: Stefanie Molin <docstringify@stefaniemolin.com>
6
6
  License: MIT License
@@ -29,8 +29,8 @@ Project-URL: Documentation, https://github.com/stefmolin/docstringify
29
29
  Project-URL: Homepage, https://github.com/stefmolin/docstringify
30
30
  Project-URL: Source, https://github.com/stefmolin/docstringify
31
31
  Keywords: ast,docstring generation,numpydoc-style docstring,pre-commit
32
- Classifier: Development Status :: 2 - Pre-Alpha
33
- Classifier: License :: OSI Approved :: Apache Software License
32
+ Classifier: Development Status :: 3 - Alpha
33
+ Classifier: License :: OSI Approved :: MIT License
34
34
  Classifier: Programming Language :: Python
35
35
  Classifier: Programming Language :: Python :: 3 :: Only
36
36
  Classifier: Programming Language :: Python :: 3.8
@@ -60,7 +60,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
60
60
 
61
61
  ```yaml
62
62
  - repo: https://github.com/stefmolin/docstringify
63
- rev: 0.1.0
63
+ rev: 0.1.1
64
64
  hooks:
65
65
  - id: docstringify
66
66
  ```
@@ -69,7 +69,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
69
69
 
70
70
  ```yaml
71
71
  - repo: https://github.com/stefmolin/docstringify
72
- rev: 0.1.0
72
+ rev: 0.1.1
73
73
  hooks:
74
74
  - id: docstringify
75
75
  args: [--threshold=0.75]
@@ -79,7 +79,7 @@ If you would like to see suggested docstring templates (inferred from type annot
79
79
 
80
80
  ```yaml
81
81
  - repo: https://github.com/stefmolin/docstringify
82
- rev: 0.1.0
82
+ rev: 0.1.1
83
83
  hooks:
84
84
  - id: docstringify
85
85
  args: [--suggest-changes]
{docstringify-0.1.0 → docstringify-0.1.1}/README.md RENAMED
@@ -9,7 +9,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
9
9
 
10
10
  ```yaml
11
11
  - repo: https://github.com/stefmolin/docstringify
12
- rev: 0.1.0
12
+ rev: 0.1.1
13
13
  hooks:
14
14
  - id: docstringify
15
15
  ```
@@ -18,7 +18,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
18
18
 
19
19
  ```yaml
20
20
  - repo: https://github.com/stefmolin/docstringify
21
- rev: 0.1.0
21
+ rev: 0.1.1
22
22
  hooks:
23
23
  - id: docstringify
24
24
  args: [--threshold=0.75]
@@ -28,7 +28,7 @@ If you would like to see suggested docstring templates (inferred from type annot
28
28
 
29
29
  ```yaml
30
30
  - repo: https://github.com/stefmolin/docstringify
31
- rev: 0.1.0
31
+ rev: 0.1.1
32
32
  hooks:
33
33
  - id: docstringify
34
34
  args: [--suggest-changes]
{docstringify-0.1.0 → docstringify-0.1.1}/pyproject.toml RENAMED
@@ -22,8 +22,8 @@ authors = [
22
22
  ]
23
23
  requires-python = ">=3.8"
24
24
  classifiers = [
25
- "Development Status :: 2 - Pre-Alpha",
26
- "License :: OSI Approved :: Apache Software License",
25
+ "Development Status :: 3 - Alpha",
26
+ "License :: OSI Approved :: MIT License",
27
27
  "Programming Language :: Python",
28
28
  "Programming Language :: Python :: 3 :: Only",
29
29
  "Programming Language :: Python :: 3.8",
{docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify/__init__.py RENAMED
@@ -3,4 +3,4 @@ Flag missing docstrings and, optionally, generate them from signatures and
3
3
  type annotations.
4
4
  """
5
5
 
6
- __version__ = '0.1.0'
6
+ __version__ = '0.1.1'
{docstringify-0.1.0 → docstringify-0.1.1}/src/docstringify.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: docstringify
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
5
5
  Author-email: Stefanie Molin <docstringify@stefaniemolin.com>
6
6
  License: MIT License
@@ -29,8 +29,8 @@ Project-URL: Documentation, https://github.com/stefmolin/docstringify
29
29
  Project-URL: Homepage, https://github.com/stefmolin/docstringify
30
30
  Project-URL: Source, https://github.com/stefmolin/docstringify
31
31
  Keywords: ast,docstring generation,numpydoc-style docstring,pre-commit
32
- Classifier: Development Status :: 2 - Pre-Alpha
33
- Classifier: License :: OSI Approved :: Apache Software License
32
+ Classifier: Development Status :: 3 - Alpha
33
+ Classifier: License :: OSI Approved :: MIT License
34
34
  Classifier: Programming Language :: Python
35
35
  Classifier: Programming Language :: Python :: 3 :: Only
36
36
  Classifier: Programming Language :: Python :: 3.8
@@ -60,7 +60,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
60
60
 
61
61
  ```yaml
62
62
  - repo: https://github.com/stefmolin/docstringify
63
- rev: 0.1.0
63
+ rev: 0.1.1
64
64
  hooks:
65
65
  - id: docstringify
66
66
  ```
@@ -69,7 +69,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
69
69
 
70
70
  ```yaml
71
71
  - repo: https://github.com/stefmolin/docstringify
72
- rev: 0.1.0
72
+ rev: 0.1.1
73
73
  hooks:
74
74
  - id: docstringify
75
75
  args: [--threshold=0.75]
@@ -79,7 +79,7 @@ If you would like to see suggested docstring templates (inferred from type annot
79
79
 
80
80
  ```yaml
81
81
  - repo: https://github.com/stefmolin/docstringify
82
- rev: 0.1.0
82
+ rev: 0.1.1
83
83
  hooks:
84
84
  - id: docstringify
85
85
  args: [--suggest-changes]
{docstringify-0.1.0 → docstringify-0.1.1}/.gitignore RENAMED
File without changes
{docstringify-0.1.0 → docstringify-0.1.1}/LICENSE RENAMED
File without changes
{docstringify-0.1.0 → docstringify-0.1.1}/setup.cfg RENAMED
File without changes