refactor(framework): Align user-facing docstrings with reStructuredText (RST) syntax#6855
Draft
refactor(framework): Align user-facing docstrings with reStructuredText (RST) syntax#6855
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to ensure Sphinx-generated framework documentation renders correctly by updating user-facing docstrings from Markdown-style formatting to reStructuredText (RST)-compatible syntax.
Changes:
- Updated inline-code formatting in the
Arraydocstring to use RST inline literals (double backticks) for one list item.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+58
to
60
| 1. By specifying explicit values for ``dtype``, ``shape``, ``stype``, and ``data``. | ||
| 2. By providing a NumPy ndarray (via the `ndarray` argument). | ||
| 3. By providing a PyTorch tensor (via the `torch_tensor` argument). |
There was a problem hiding this comment.
This docstring line was updated to RST inline-literal syntax (double backticks), but the adjacent list items still use Markdown-style single backticks (e.g., ndarray, torch_tensor). Since Sphinx/RST will render single backticks as emphasis, these should be updated to RST inline literals (ndarray, torch_tensor) for consistent user-facing docs output.
github-actions
bot
added
the
Maintainer
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
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.
Problem
The framework documentation generated via
framework/dev/build-docs.shuses Sphinx, which expects reStructuredText (RST) formatting. However, many docstrings in the codebase are currently written in Markdown syntax. For example, single backticks are used for inline code, which Sphinx interprets as italic text instead of code (RST requires double backticks).Solution
Update all user-facing docstrings rendered by Sphinx to use RST-compatible syntax, ensuring consistent and correct formatting in the generated documentation. Non user-facing docstrings shall stay unchanged.