Skip to content

Update common.py #5

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
merged 2 commits into from
Jun 5, 2024
Merged

Update common.py #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3415c44
Update common.py
sumansaurabh Jun 5, 2024
4b48606
Update setup.py
sumansaurabh Jun 5, 2024
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
6 changes: 5 additions & 1 deletion PyDocSmith/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,11 @@ def format_docstring_to_pep257(docstring: Docstring, width: int = 72) -> Docstri
for meta in docstring.meta:
if meta.description:
# Ensure meta descriptions are wrapped according to PEP 8
meta.description = textwrap.fill(meta.description.strip(), width)
split_description = meta.description.split("\n")
for itm, idx in enumerate(split_description):
split_description[idx] = textwrap.fill(itm.strip(), width)

meta.description = "\n".join(split_description)
if meta.args:
# Clean up args to ensure they are stripped of extra spaces
meta.args = [arg.strip() for arg in meta.args if arg.strip()]
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.3",
version="0.1.4",
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