Adding explanation about BG examples in README and quick start#1462
Open
Adding explanation about BG examples in README and quick start#1462
Conversation
tinko92
approved these changes
May 5, 2026
Collaborator
|
Errors: we should first merge that PR |
vissarion
force-pushed
the
readme_examples_addition
branch
from
6672b15 to
f8281fb
Compare
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
3 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.
This pull request updates documentation to clarify the organization and location of code examples within the Boost.Geometry project as identified in the relevant JOSS review (comment1, comment2).
The changes help users distinguish between standalone tutorial programs and smaller reference snippets, making it easier to find relevant example code.
Documentation improvements:
README.mdto specify that thedocdirectory contains QuickBook documentation sources with embedded examples indoc/src/examples/, and clarified that theexampledirectory contains standalone examples.doc/quickstart.qbkdirecting users to theexample/directory for longer tutorial-style programs and todoc/src/examples/for smaller reference-oriented snippets.