You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I wanted to suggest an improvement to the documentation format gently. While the .. testcode:: blocks are great for testing examples, they present two minor friction points for new users:
Readability
The indented code blocks without syntax highlighting make it harder to scan/understand examples quickly
Copy-Paste Experience
When copying code directly from GitHub's rendered documentation:
The extra indentation requires manual adjustment
Hidden .. testoutput:: blocks can accidentally get copied
Hi,
I wanted to suggest an improvement to the documentation format gently. While the
.. testcode::
blocks are great for testing examples, they present two minor friction points for new users:Readability
The indented code blocks without syntax highlighting make it harder to scan/understand examples quickly
Copy-Paste Experience
When copying code directly from GitHub's rendered documentation:
.. testoutput::
blocks can accidentally get copiedWould you consider either:
This would make it even easier for folks to:
I'm happy to help submit a PR if this aligns with the project's direction! Just let me know what approach you'd prefer.
Thanks!
The text was updated successfully, but these errors were encountered: