Skip to content
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

Replace docstring "Placeholder" text #597

Open
mfisher87 opened this issue Jun 11, 2024 · 2 comments
Open

Replace docstring "Placeholder" text #597

mfisher87 opened this issue Jun 11, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Collaborator

Recently, we added placeholder subject lines to docstrings which lacked subject lines but contained other data, like parameter annotations or return annotation. We needed to do this because:

  • the code formatter didn't understand this situation and would try to fix it by bringing the "Returns:" line to the subject, and
  • this would cause the docs to no longer correctly render the return type

We need to replace "Placeholder" with a real subject line for each of those functions/classes.

@Sherwin-14
Copy link
Contributor

Should we replace the placeholder with a brief description of purpose of the function?

@mfisher87
Copy link
Collaborator Author

Yes, exactly :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants