docs: add reference for hints #54
Open
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
Collaborator
|
Thanks @upils . Blocking the merging while waiting for canonical/chisel#263. @asanvaq it can be reviewed anyway |
Collaborator
Author
|
@cjdcordeiro canonical/chisel#263 is now merged so this one can also be once reviewed and approved. |
cjdcordeiro
reviewed
Jan 27, 2026
Collaborator
cjdcordeiro
left a comment
cjdcordeiro
left a comment
There was a problem hiding this comment.
thanks. LGTM. just a couple of typos to be fixed and I'll approve it from my side
asanvaq
requested changes
Jan 28, 2026
Comment on lines
+498
to
+508
| - Be a maximum of 40 characters long. | ||
| - Consist only of alphanumeric characters, periods (`.`), commas (`,`), | ||
| semicolons (`;`), parentheses (`(`, `)`). | ||
| - Be sentence case: Start with an uppercase letter (e.g. `All timezones` not | ||
| `all timezones`). | ||
| - Use semicolons to separate multiple unrelated fragments of information. | ||
| (e.g. `No jaotc; binutils required`). | ||
| - No trailing punctuation: Do not end with a period or other punctuation | ||
| marks. | ||
| - No line breaks: Be a single line. | ||
| - Use uppercase for acronyms (e.g. `HTTP` not `Http`). |
Contributor
There was a problem hiding this comment.
Suggested change
| - Be a maximum of 40 characters long. | |
| - Consist only of alphanumeric characters, periods (`.`), commas (`,`), | |
| semicolons (`;`), parentheses (`(`, `)`). | |
| - Be sentence case: Start with an uppercase letter (e.g. `All timezones` not | |
| `all timezones`). | |
| - Use semicolons to separate multiple unrelated fragments of information. | |
| (e.g. `No jaotc; binutils required`). | |
| - No trailing punctuation: Do not end with a period or other punctuation | |
| marks. | |
| - No line breaks: Be a single line. | |
| - Use uppercase for acronyms (e.g. `HTTP` not `Http`). | |
| - A maximum of 40 characters long | |
| - Only of alphanumeric characters, periods (`.`), commas (`,`), | |
| semicolons (`;`), parentheses (`(`, `)`) | |
| - Sentence case: Start with an uppercase letter (e.g. `All timezones` not | |
| `all timezones`) | |
| - Semicolons to separate multiple unrelated fragments of information | |
| (e.g. `No jaotc; binutils required`) | |
| - No trailing punctuation: Do not end with a period or other punctuation | |
| marks | |
| - No line breaks: must be a single line | |
| - Uppercase for acronyms (e.g. `HTTP` not `Http`) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR adds the reference for the
hintfield added to slice definition files.It must wait for canonical/chisel#263 to be merged and released.