Skip to content

⚡️ Speed up function format_docstring by 5% #177

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

Open
codeflash-ai wants to merge 1 commit into
base: master
Choose a base branch
from
Open

⚡️ Speed up function format_docstring by 5% #177

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
9 changes: 7 additions & 2 deletions mlflow/utils/docstring_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,10 +152,15 @@ def format_docstring(param_docs):
p2: doc2
doc2 second line
"""
param_docs = ParamDocs(param_docs)
# Avoid double wrapping if already ParamDocs instance.
if type(param_docs) is not ParamDocs:
param_docs = ParamDocs(param_docs)


def decorator(func):
func.__doc__ = param_docs.format_docstring(func.__doc__)
doc = func.__doc__
if doc is not None:
func.__doc__ = param_docs.format_docstring(doc)
return func

return decorator
Expand Down