Skip to content

Fixes code samples in Sphinx docs that should have border#577

Merged
swahtz merged 1 commit into
openvdb:mainfrom
swahtz:fix/code_sample_border
Apr 6, 2026
Merged

Fixes code samples in Sphinx docs that should have border#577
swahtz merged 1 commit into
openvdb:mainfrom
swahtz:fix/code_sample_border

Conversation

@swahtz

@swahtz swahtz commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the docstrings in the fvdb/jagged_tensor.py file to improve the formatting and clarity of example code blocks. The changes ensure consistent usage of reStructuredText (reST) code block directives, add missing code block formatting, and clarify example outputs by commenting them out. No functional code changes were made.

Documentation formatting improvements:

  • Replaced incorrect or inconsistent code block directives (such as ... code-block:: python) with the correct .. code-block:: python in all relevant docstrings. [1] [2] [3] [4] [5] [6] [7] [8] [9]
  • Added missing .. code-block:: python or .. code-block:: text directives to several example sections for better rendering in documentation tools. [1] [2] [3] [4] [5] [6] [7]
  • Updated example outputs in code blocks to be comments (using #) instead of uncommented lines, clarifying that these lines are not executable code. [1] [2] [3] [4]
  • Improved clarity in example outputs and argument documentation, such as using double backticks for inline code and clarifying which APIs to use for certain operations.
  • Removed unnecessary blank lines and fixed indentation in several docstring examples for consistency. [1] [2]

Fixes #304

Fixes openvdb#304

Signed-off-by: Jonathan Swartz <jonathan@jswartz.info>
@swahtz swahtz requested a review from a team as a code owner March 31, 2026 02:16
@swahtz swahtz added the documentation Improvements or additions to documentation label Mar 31, 2026
@swahtz swahtz added this to the v0.5 milestone Mar 31, 2026
@swahtz swahtz self-assigned this Mar 31, 2026
@swahtz swahtz merged commit 68ee094 into openvdb:main Apr 6, 2026
38 checks passed
@swahtz swahtz deleted the fix/code_sample_border branch April 6, 2026 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Code samples in Sphinx docs should have border.

2 participants