Update docstrings in NS and SS modules for consistency #36
Conversation
This file contains hidden or 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
- Simplify module docstrings to one-line 'Public API for X' format - Shorten class attribute descriptions to be more concise - Simplify function parameter and return descriptions - Follow BlackJAX conventions: brief descriptions, minimal explanations - Ensure consistent terminology (use 'a' before acronyms) - Add brief docstrings to inner kernel functions - Match the concise, technical tone of other BlackJAX modules
|
Closing as API still in flux, so exercise will likely need to be repeated |
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.
Summary
This PR updates docstrings throughout the Nested Sampling and Slice Sampling modules to match BlackJAX's established documentation style.
Changes
Motivation
The NS and SS module docstrings were more verbose than the rest of BlackJAX. This PR brings them in line with the established style used in modules like , , , and .
Testing
No functional changes were made - only documentation updates.