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.

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

Jump to bottom

Change docstring location for functions #244

Open
tjmadonna opened this issue Dec 1, 2023 · 0 comments
Open

Change docstring location for functions #244

tjmadonna opened this issue Dec 1, 2023 · 0 comments

Comments

@tjmadonna
Copy link
Contributor

tjmadonna commented Dec 1, 2023 •
edited
Loading

Changing the docstring location so that they are inside the function provides better documentation in IDEs.

https://peps.python.org/pep-0257/#multi-line-docstrings

Example:

Screenshot 2023-12-01 at 1 35 18 PM
libpitt added a commit that referenced this issue Jan 9, 2024
@libpitt
Start following #244 documentation rule
20cac24
@maxsibilla maxsibilla added this to CODCC May 20, 2024
@maxsibilla maxsibilla moved this to Backlog in CODCC May 20, 2024
@github-project-automation github-project-automation bot moved this to Backlog in CODCC Aug 30, 2024
tjmadonna added a commit that referenced this issue Sep 4, 2024
@tjmadonna
Moving docstrings inside func for schema triggers
27265ca 
This is a continuation of the issue #244. This follows the guidelines
for docstrings in Python using numpy style.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
CODCC
Status: Backlog
CODCC
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tjmadonna