Skip to content

Update Readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sumansaurabh merged 1 commit into from
Feb 20, 2024
Merged

Update Readme #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
__pycache__
*.egg-info
poetry.lock
dist
build
.vscode
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
The project is a fork from the original project - https://github.com/rr-/docstring_parser/

Based on the provided document, here is a README outline for the Python package it describes:

---
I have updated it based on use case for - https://www.snorkell.ai/

# PyDocSmith

Expand Down Expand Up @@ -66,6 +64,13 @@ print(docstring_text)
- **Parse From Object:** PyDocSmith can parse docstrings directly from Python objects, including classes and modules, incorporating attribute docstrings into the structured representation.
- **Custom Rendering Styles:** Customize the rendering of docstrings with compact or detailed styles, and specify custom indentation for the generated docstring text.

## Things that have been modified wrt to docstring_parser

1. Better heuristics to detect docstring style
2. Google Docstring has been modified to accommodate Notes, Examples
3. Sometime GoogleDoc string doesn't have proper indentation specially when generated from LLMs like GPT or Mistral. PyDocSmith can fix those bad docstrings.
4. Additional test-cases were added to accommodate a different style of GoogleDocstring

## Contributing

Contributions are welcome! Please submit pull requests or report issues on the project's GitHub page.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name="PyDocSmith",
version="0.1",
version="0.1.1",
description="It parses and composes docstrings in Google, Numpydoc, ReST and Epydoc.",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
Expand Down