Skip to content

Reformat docstrings #1835

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.

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 12 commits into from
Oct 22, 2019
3 changes: 2 additions & 1 deletion packages/python/plotly/plotly/express/_doc.py
Original file line number Diff line number Diff line change
@@ -405,7 +405,7 @@


def make_docstring(fn):
result = (fn.__doc__ or "") + "\nArguments:\n"
result = (fn.__doc__ or "") + "\nParameters\n----------\n"
for arg in inspect.getargspec(fn)[0]:
d = (
" ".join(docs[arg] or "")
@@ -414,5 +414,6 @@ def make_docstring(fn):
)
result += " %s: %s\n" % (arg, d)
result += "Returns:\n"
result += "\nReturns\n-------\n"
result += " A `Figure` object."
return result