Skip to content

Commit

Permalink
add func descriptions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Farhan-Faisal committed Jan 9, 2025
1 parent 25f4e9a commit da40dbd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Functions Included

- **`generate_docstring_template(func_file: str, output_file: str, auto_generate: bool = False, ) -> str`**:
- **`generate_docstring_template(func: Callable, output_file: str, auto_generate: bool = False) -> str`**:
The main end-user function that generates either a docstring template with placeholders or a fully detailed docstring if `auto_generate` is set to `True`.

- **`read_user_function(func: Callable) -> str`**:
Expand Down

0 comments on commit da40dbd

Please sign in to comment.