Touch up text around require statements w.r.t. -I / -L flags #25072
Conversation
This file contains 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
[based on feedback and suggestions by @psath] Based on feedback in chapel-lang#24963, this PR strives to improve the documentation of the ``require`` statement to clarify that it doesn't accept general `chpl` command-line flags and refactors the description of the -I and -L flags to try and clarify their role in common to listing files on the command-line or `require` statements. While here, I also did some wordsmithing and formatting adjustments. Resolves chapel-lang#24963. --- Signed-off-by: Brad Chamberlain <bradcray@users.noreply.github.com>
|
@lydia-duncan: Would you review this since you were contributing to and following the discussion on #25072? |
lydia-duncan
approved these changes
May 20, 2024
There was a problem hiding this comment.
Thanks Brad! I was hoping to get to this myself as well but had been distracted by other things :(
This is a strong improvement to the section in general and I appreciate you taking it on. I had one minor wordsmithing nit but otherwise think this is good to go as is
--- Signed-off-by: Brad Chamberlain <bradcray@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[based on feedback and suggestions by @psath]
Based on feedback in #24963, this PR strives to improve the documentation of the
requirestatement to clarify that it doesn't accept generalchplcommand-line flags and refactors the description of the -I and -L flags to try and clarify their role in common to listing files on the command-line orrequirestatements. While here, I also did some wordsmithing and formatting adjustments.Resolves #24963.