docstringify 0.5.0__tar.gz → 0.5.1__tar.gz

{docstringify-0.5.0 → docstringify-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstringify
-Version: 0.5.0
+Version: 0.5.1
 Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 Author-email: Stefanie Molin <docstringify@stefaniemolin.com>
 License: MIT License
@@ -49,9 +49,58 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-randomly; extra == "dev"
 Dynamic: license-file
 
-# docstringify
+# Docstringify
 Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 
+## About
+
+Given a file, `test.py`, with the following contents:
+
+```python
+def say_hello(name: str = 'World') -> None:
+    print(f'Hello, {name}!')
+```
+
+You can use Docstringify in three modes:
+
+1. Flag missing docstrings:
+    ```
+    test is missing a docstring
+    test.say_hello is missing a docstring
+    ```
+2. Suggest docstring templates based on type annotations:
+    ```
+    test is missing a docstring
+    Hint:
+    """__description__"""
+
+    test.say_hello is missing a docstring
+    Hint:
+    """
+    __description__
+
+    Parameters
+    ----------
+    name : str, default="World"
+        __description__
+    """
+    ```
+3. Add docstring templates to source code files:
+    ```python
+    """__description__"""
+
+    def say_hello(name: str = 'World') -> None:
+        """
+        __description__
+
+        Parameters
+        ----------
+        name : str, default="World"
+            __description__
+        """
+        print(f'Hello, {name}!')
+    ```
+
 ## Usage
 
 ### Pre-commit hook
@@ -60,7 +109,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
 ```
@@ -69,7 +118,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--threshold=0.75]
@@ -79,7 +128,7 @@ If you would like to see suggested docstring templates (inferred from type annot
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--suggest-changes=numpydoc]
@@ -89,7 +138,7 @@ Use `--make-changes` to create a copy of each file with docstring templates. Her
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--make-changes=google]
@@ -170,3 +219,7 @@ Docstring templates written to /.../test_docstringify.py
 ```
 
 If you want to overwrite the file with the edits, pass `overwrite=True` to `DocstringTransformer()`.
+
+## Contributing
+
+Please consult the [contributing guidelines](https://github.com/stefmolin/docstringify/blob/main/CONTRIBUTING.md).

{docstringify-0.5.0 → docstringify-0.5.1}/README.md

@@ -1,6 +1,55 @@
-# docstringify
+# Docstringify
 Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 
+## About
+
+Given a file, `test.py`, with the following contents:
+
+```python
+def say_hello(name: str = 'World') -> None:
+    print(f'Hello, {name}!')
+```
+
+You can use Docstringify in three modes:
+
+1. Flag missing docstrings:
+    ```
+    test is missing a docstring
+    test.say_hello is missing a docstring
+    ```
+2. Suggest docstring templates based on type annotations:
+    ```
+    test is missing a docstring
+    Hint:
+    """__description__"""
+
+    test.say_hello is missing a docstring
+    Hint:
+    """
+    __description__
+
+    Parameters
+    ----------
+    name : str, default="World"
+        __description__
+    """
+    ```
+3. Add docstring templates to source code files:
+    ```python
+    """__description__"""
+
+    def say_hello(name: str = 'World') -> None:
+        """
+        __description__
+
+        Parameters
+        ----------
+        name : str, default="World"
+            __description__
+        """
+        print(f'Hello, {name}!')
+    ```
+
 ## Usage
 
 ### Pre-commit hook
@@ -9,7 +58,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
 ```
@@ -18,7 +67,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--threshold=0.75]
@@ -28,7 +77,7 @@ If you would like to see suggested docstring templates (inferred from type annot
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--suggest-changes=numpydoc]
@@ -38,7 +87,7 @@ Use `--make-changes` to create a copy of each file with docstring templates. Her
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--make-changes=google]
@@ -119,3 +168,7 @@ Docstring templates written to /.../test_docstringify.py
 ```
 
 If you want to overwrite the file with the edits, pass `overwrite=True` to `DocstringTransformer()`.
+
+## Contributing
+
+Please consult the [contributing guidelines](https://github.com/stefmolin/docstringify/blob/main/CONTRIBUTING.md).

{docstringify-0.5.0 → docstringify-0.5.1}/src/docstringify/__init__.py

@@ -3,4 +3,4 @@ Flag missing docstrings and, optionally, generate them from signatures and
 type annotations.
 """
 
-__version__ = '0.5.0'
+__version__ = '0.5.1'

{docstringify-0.5.0 → docstringify-0.5.1}/src/docstringify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstringify
-Version: 0.5.0
+Version: 0.5.1
 Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 Author-email: Stefanie Molin <docstringify@stefaniemolin.com>
 License: MIT License
@@ -49,9 +49,58 @@ Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-randomly; extra == "dev"
 Dynamic: license-file
 
-# docstringify
+# Docstringify
 Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 
+## About
+
+Given a file, `test.py`, with the following contents:
+
+```python
+def say_hello(name: str = 'World') -> None:
+    print(f'Hello, {name}!')
+```
+
+You can use Docstringify in three modes:
+
+1. Flag missing docstrings:
+    ```
+    test is missing a docstring
+    test.say_hello is missing a docstring
+    ```
+2. Suggest docstring templates based on type annotations:
+    ```
+    test is missing a docstring
+    Hint:
+    """__description__"""
+
+    test.say_hello is missing a docstring
+    Hint:
+    """
+    __description__
+
+    Parameters
+    ----------
+    name : str, default="World"
+        __description__
+    """
+    ```
+3. Add docstring templates to source code files:
+    ```python
+    """__description__"""
+
+    def say_hello(name: str = 'World') -> None:
+        """
+        __description__
+
+        Parameters
+        ----------
+        name : str, default="World"
+            __description__
+        """
+        print(f'Hello, {name}!')
+    ```
+
 ## Usage
 
 ### Pre-commit hook
@@ -60,7 +109,7 @@ Add the following to your `.pre-commit-config.yaml` file to block commits with m
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
 ```
@@ -69,7 +118,7 @@ By default, all docstrings are required. If you want to be more lenient, you can
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--threshold=0.75]
@@ -79,7 +128,7 @@ If you would like to see suggested docstring templates (inferred from type annot
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--suggest-changes=numpydoc]
@@ -89,7 +138,7 @@ Use `--make-changes` to create a copy of each file with docstring templates. Her
 
 ```yaml
 - repo: https://github.com/stefmolin/docstringify
-  rev: 0.5.0
+  rev: 0.5.1
   hooks:
     - id: docstringify
       args: [--make-changes=google]
@@ -170,3 +219,7 @@ Docstring templates written to /.../test_docstringify.py
 ```
 
 If you want to overwrite the file with the edits, pass `overwrite=True` to `DocstringTransformer()`.
+
+## Contributing
+
+Please consult the [contributing guidelines](https://github.com/stefmolin/docstringify/blob/main/CONTRIBUTING.md).