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

Update Docstrings #44

Closed
dscolby opened this issue May 11, 2024 · 4 comments
Closed

Update Docstrings #44

dscolby opened this issue May 11, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@dscolby
Copy link
Owner

dscolby commented May 11, 2024

They should have separate sections for notes and references and not have "..." to sandwich the arguments section. The updated format should also be in the contributor guidelines.
@dscolby dscolby added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 11, 2024
@dscolby
Copy link
Owner Author

dscolby commented May 12, 2024

Fixed with commit c0a10d3.

@dscolby dscolby closed this as completed May 12, 2024
@dscolby dscolby reopened this Jun 9, 2024
@dscolby
Copy link
Owner Author

dscolby commented Jun 9, 2024

We also need to have the julia> in Examples and list all the methods for each function.

@dscolby dscolby mentioned this issue Jun 11, 2024
Closed
@dscolby
Copy link
Owner Author

dscolby commented Jun 15, 2024

And we should also have doctests where practical.

@dscolby
Copy link
Owner Author

dscolby commented Jun 15, 2024

Done in commit bef902b.

@dscolby dscolby closed this as completed Jun 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dscolby