Rework the guideline description to remove the incorrect claim that a… #84
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
…n explicit Amplification section exists (instead, whatever paragraph immediately opens the guideline is just normative). We can continue to call it that but the subheading is not necessary.
PLeVasseur
reviewed
May 25, 2025
There was a problem hiding this comment.
Hey @AlexCeleste -- I left comments to make sure I understand the thrust of what you've written. Thanks for taking a stab at this!
| @@ -308,15 +304,27 @@ what it covers. | |||
| Content **SHOULD** aim to be as short and self-contained as possible, while still explaining | |||
| the scope of the guideline. | |||
|
|
|||
| Content **SHOULD NOT** cover the rationale for the guideline, which is done in the ``rationale`` section. | |||
| Guideline content consists of an Amplification and any Exceptions, which are normative, | |||
There was a problem hiding this comment.
Oh, is this the reason for removing the content up above in the example guideline?
Any text under the guideline should be either an Amplification or an Exception?
| @@ -308,15 +304,27 @@ what it covers. | |||
| Content **SHOULD** aim to be as short and self-contained as possible, while still explaining | |||
| the scope of the guideline. | |||
|
|
|||
| Content **SHOULD NOT** cover the rationale for the guideline, which is done in the ``rationale`` section. | |||
| Guideline content consists of an Amplification and any Exceptions, which are normative, | |||
There was a problem hiding this comment.
What do you think?
Suggested change
| Guideline content consists of an Amplification and any Exceptions, which are normative, | |
| Guideline content consists of zero or one Amplification and zero or more Exceptions, which are normative, |
Co-authored-by: Pete LeVasseur <[email protected]>
✅ Deploy Preview for scrc-coding-guidelines ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…bars (rustfoundation#67) * Add --verbose flag to reduce logging to warning+ level, Add spinner * Remove spinner, Introduce tqdm, wrapping important loops in tqdm * Add tqdm to pyproject.toml * refactor: Add common.py to hold logger and tqdm wrapper, Disable tqdm progress on verbose mode, Remove Unused imports * Remove extra return * Apply suggestions from code review Co-authored-by: Pete LeVasseur <[email protected]> * Fix logger indentation * merge --verbose into --debug, remove time.sleep() --------- Co-authored-by: Pete LeVasseur <[email protected]>
Performed after review of changes.
|
moved to #127 corresponding to different issue now aiming to be addressed |
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.
…n explicit Amplification section exists (instead, whatever paragraph immediately opens the guideline is just normative). We can continue to call it that but the subheading is not necessary.