[fix] Add docstring and parameter formatting improvements#766
Merged
Conversation
Improved docstring formatting and parameter documentation in _delay.py and slow_points.py for better clarity and consistency. No functional changes were made to the code logic.
This reverts commit d3fdde2.
- Convert docstring section headers from rst underline format to :: format - Fixes sphinx_autodoc_typehints extension errors - Only modify the problematic Examples, Parameters, Returns sections - Affects 21 core files with docstring formatting issues
Replaces NumPy-style 'Parameters' and 'Returns' docstring sections (using '----------') with reStructuredText-style 'Parameters::' and 'Returns::' across multiple modules. This improves consistency and compatibility with documentation tools that expect reST formatting.
chaoming0625
approved these changes
Aug 1, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improved docstring formatting and parameter documentation in _delay.py and slow_points.py for better clarity and consistency. No functional changes were made to the code logic.