[doc] Make basic configuration example more intuitive w.r.t. to modules systems #1932
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
A laptop would generally not have modules, so saying that explicitly will help highlight to new users that a module setting can be useful. There is a modules setting below for daint, but at least one user skimmed over the more complex case. The line numbers for the literal includes need to be bumped if they are greater than 15, and a range including 15 is shown, then the highlighting can need a bump. Note that the latter index within the range shown, so don't always need a bump. Fixes reframe-hpc#1887
Codecov Report
@@ Coverage Diff @@
## master #1932 +/- ##
=======================================
Coverage 87.97% 87.97%
=======================================
Files 50 50
Lines 8496 8496
=======================================
Hits 7474 7474
Misses 1022 1022 Continue to review full report at Codecov.
|
jjotero
approved these changes
Apr 16, 2021
Contributor
jjotero
left a comment
jjotero
left a comment
There was a problem hiding this comment.
Part of me still thinks that it's not necessary to add the optional nomod parameter in the config example and this should be just clarified in the text. On the other hand, this certainly adds clarity, which I guess it's the end goal of the docs :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Replaces #1890
Fixes #1887.