Fix tutorial documentation Jamroot/Jamfile confusion #507
Conversation
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
The tutorial was incorrectly stating that the tutorial directory contains a Jamroot file, when it actually contains a Jamfile. The Jamroot is in the parent example directory. This was causing confusion as the link pointed to example/Jamroot but the text suggested it was in the tutorial directory. Updated the documentation to clarify: - The tutorial directory contains hello.cpp, hello.py, and Jamfile - The parent example directory contains the Jamroot template - Made the link description clearer about the file location Fixes #1045 Signed-off-by: Samaresh Kumar Singh <[email protected]>
Author
|
I was following the tutorial to learn Boost.Python and kept looking for a Jamroot file in the tutorial directory that didn't exist. Took me a while to realize it was actually a Jamfile, and the Jamroot was in the parent directory. Hope this clarification helps others avoid the same confusion |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I noticed the tutorial documentation had some confusing references about where the Jamroot file is located. The docs said the tutorial directory contains a Jamroot, but it actually has a Jamfile. The actual Jamroot is in the parent example directory.
This was causing confusion because the link correctly pointed to
../example/Jamroot, but the text suggested it was in the tutorial directory itself.Changes:
This should help people following the tutorial find the right files without confusion.
Fixes boostorg/boost#1045