From 25f4e9a91cd38edd5ca300d797d8b2d38cf6d946 Mon Sep 17 00:00:00 2001 From: Farhan-Faisal Date: Thu, 9 Jan 2025 11:05:16 -0800 Subject: [PATCH 1/2] checked conduct, license, contributing --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fc8ba2c..646b876 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ # fml_doc_generator -doc string generator - ## Summary `fml_doc_generator` is a Python package designed to simplify the process of writing docstrings for user-defined functions. It offers an automated way to generate docstring templates or fully detailed docstrings through integration with the OpenAI API. By streamlining documentation, it helps developers save time, improve code readability, and maintain consistent documentation standards across projects. ## Functions Included -- **`generate_docstring_template(func: Callable, auto_generate: bool = False, output_file: str = None) -> str`**: +- **`generate_docstring_template(func_file: str, 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`**: @@ -29,8 +27,10 @@ doc string generator If you are aware of a similar tool, feel free to contribute to our documentation by suggesting it! -## Authors -Farhan Bin Faisal, Michael Suriawan, Lukman Lateef +## Contributors +- Farhan Bin Faisal +- Michael Suriawan +- Lukman Lateef ## Contributing From da40dbd7a5c1d8897db124d78e534bcb3e7edf4e Mon Sep 17 00:00:00 2001 From: Farhan-Faisal Date: Thu, 9 Jan 2025 11:12:01 -0800 Subject: [PATCH 2/2] add func descriptions to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 646b876..b3febfd 100644 --- a/README.md +++ b/README.md @@ -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`**: