Open
Conversation
Long headings in example files were being wrapped by the build script, causing them to be rendered incorrectly in the documentation. This commit modifies `docs/scripts/build_examples.py` to prevent wrapping of lines that start with `#` (headings). Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Resolves minor documentation usability issues by improving anchor linking in the README and preventing unwanted line-wrapping in generated example docs.
Changes:
- Add an explicit HTML anchor in
README.mdto make the installation section link reliably clickable on GitHub. - Update the examples build script to avoid wrapping long lines that are comments.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/scripts/build_examples.py | Skips automatic line wrapping for comment lines to prevent formatting issues in generated docs. |
| README.md | Adds a stable HTML anchor for the installation section to improve linkability on GitHub. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AVHopp
approved these changes
Feb 16, 2026
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.
Fixes #727 and #578
Changed
On my fork this has fixed the issues:
It does not remove the visible
(installation)=from the README but since there is no net loss this solution should be accepted as Issue closing.