📚 Build-uenv: consistently use <build-path>
#268
Merged
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 documentation section was using both `<build-path>` and `<build-dir>`. This makes it unclear that they are both referring to the same string. Here we choose to consistently use `<build-path>`, since it is a path to a directory.
Contributor
Author
|
Not an expert on |
|
preview available: https://docs.tds.cscs.ch/268 |
bcumming
approved these changes
Sep 25, 2025
Member
bcumming
left a comment
bcumming
left a comment
There was a problem hiding this comment.
Thanks @mbercx for improving the docs!
Technically, build-dir might be a little more appropriate, because in POSIX, path can be a directory, file, symlink etc.
But, it doesn't matter whether we use build-dir or build-path, so long as it is consistent.
Contributor
Author
Very happy to contribute! Also: I'm back to using the CSCS facilities after a while, and I must say these new docs look spiffy. 👌 |
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.
The documentation section was using both
<build-path>and<build-dir>. This makes it unclear that they are both referring to the same string.Here we choose to consistently use
<build-path>, since it is a path to a directory.