-
Notifications
You must be signed in to change notification settings - Fork 24
feat(Fift): Words, Constants and Variables page #1472
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the update—languages/fift/variables.mdx: one inline suggestion to align the wording with your style guide. Please apply the inline suggestion.
| // Define word x so that it reads the box contents. | ||
| // Now, x can be treated as if | ||
| // it was the "variable". | ||
| // In other words, instead of writing "x-box @" | ||
| // to read the variable contents, simply write "x". | ||
| { x-box @ } : x |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[HIGH] Banned filler word “simply” in body text
The comment explaining the getter x includes the phrase “simply write x” on these lines. The extended style guide explicitly bans filler and hedging terms like “simply” in instructional text and requires neutral, precise wording instead, so this phrasing violates a MUST-NOT rule and creates an inconsistent tone. Replacing “simply” with neutral language keeps the instruction clear while aligning with the documented style requirements, as outlined in https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L214-L220.
| // Define word x so that it reads the box contents. | |
| // Now, x can be treated as if | |
| // it was the "variable". | |
| // In other words, instead of writing "x-box @" | |
| // to read the variable contents, simply write "x". | |
| { x-box @ } : x | |
| // Define word x so that it reads the box contents. | |
| // Now, x can be treated as if | |
| // it was the "variable". | |
| // In other words, instead of writing "x-box @" | |
| // to read the variable contents, write "x". | |
| { x-box @ } : x |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
Closes #1467.