Update documentation site and docstrings #570
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
abhro
commented
Jul 16, 2024
abhro
commented
- Fix markdown usage
- Make code examples more easy to read
- Use Documenter v1 for building
Fix language tags in code block examples and add fences for indented code blocks
The docstring lists the whole function and usage of all 4 methods defined shortly thereafter in the file. Establish better neutrality by attaching it to a "method-less" function declaration rather than a specific method.
Docstrings are more about usage, and seeing Val(filter_id) gives a clearer idea on how to call the method
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #570 +/- ##
==========================================
- Coverage 87.00% 86.99% -0.01%
==========================================
Files 31 31
Lines 4317 4315 -2
==========================================
- Hits 3756 3754 -2
Misses 561 561 ☔ View full report in Codecov by Sentry. |
|
Thank you for this cleanup ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.