Skip to content

Add documentation for HIGHLIGHT regions in README #833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BenjaminMichaelis merged 2 commits into from
Oct 3, 2025
Merged

Add documentation for HIGHLIGHT regions in README #833

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c9335a
Initial plan
Copilot Oct 3, 2025
f91f6f9
Add documentation for HIGHLIGHT regions in README
Copilot Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ When you see matching `#region INCLUDE` and `#endregion INCLUDE` tags in a listi

When there are matching `#region EXCLUDE` and `#endregion EXCLUDE` tags in a listing, even if these are within two `INCLUDE` tags, this section is omitted from being visible in the book and replaced with a `// ...` just to try and bring more clarity to the point that is actually being taught in that listing.

When you see matching `#region HIGHLIGHT` and `#endregion HIGHLIGHT` tags within an `INCLUDE` region, this indicates that the particular code section is emphasized in the book, typically with special formatting or shading to draw attention to the key concept being demonstrated.

In addition, any line that ends with a `// EXCLUDE` is a line that is omitted from being seen in the book.

## Questions/Bugs
Expand Down
Loading