Skip to content

Conversation

@jeshecdom
Copy link
Contributor

Closes #1467.

Copy link

@github-actions github-actions bot left a 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.

Comment on lines 181 to 186
// 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
Copy link

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.

Suggested change
// 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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Fift > Constants, Variables, Words]

2 participants