-
Notifications
You must be signed in to change notification settings - Fork 14
fix: standardize SHA/Sha formatting #1428
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—there’s one inline suggestion in foundations/whitepapers/tblkch.mdx: please apply the inline suggestion to align the text with the style guide.
| ### 2.2.1. Message uniqueness | ||
|
|
||
| Before continuing, let us observe that any (internal) message is *unique*. Recall that a message contains its full source address along with its logical creation time, and all outbound messages created by the same smart contract have strictly increasing logical creation times (cf. [1.4.6](#1-4-6-logical-time-in-the-ton-blockchain)); therefore, the combination of the full source address and the logical creation time uniquely defines the message. Since we assume the chosen hash function $\text{Sha256}$ to be collision resistant, *a message is uniquely determined by its hash*, so we can identify two messages if we know that their hashes coincide. | ||
| Before continuing, let us observe that any (internal) message is *unique*. Recall that a message contains its full source address along with its logical creation time, and all outbound messages created by the same smart contract have strictly increasing logical creation times (cf. [1.4.6](#1-4-6-logical-time-in-the-ton-blockchain)); therefore, the combination of the full source address and the logical creation time uniquely defines the message. Since we assume the chosen hash function SHA-256 to be collision resistant, *a message is uniquely determined by its hash*, so we can identify two messages if we know that their hashes coincide. |
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] First-person plural pronoun in technical body text
The sentence on this line uses “let us,” a first-person plural pronoun that directly includes the author and reader, which violates the documentation style requirement to avoid first-person author pronouns in body text (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L251-L261). In technical reference material, this conversational tone can reduce clarity and consistency across documents. Rephrasing in a neutral, imperative style preserves the meaning while aligning with the established style guide. The rest of the paragraph already uses neutral descriptive language, so only the leading clause needs adjustment.
| Before continuing, let us observe that any (internal) message is *unique*. Recall that a message contains its full source address along with its logical creation time, and all outbound messages created by the same smart contract have strictly increasing logical creation times (cf. [1.4.6](#1-4-6-logical-time-in-the-ton-blockchain)); therefore, the combination of the full source address and the logical creation time uniquely defines the message. Since we assume the chosen hash function SHA-256 to be collision resistant, *a message is uniquely determined by its hash*, so we can identify two messages if we know that their hashes coincide. | |
| Before continuing, observe that any (internal) message is *unique*. Recall that a message contains its full source address along with its logical creation time, and all outbound messages created by the same smart contract have strictly increasing logical creation times (cf. [1.4.6](#1-4-6-logical-time-in-the-ton-blockchain)); therefore, the combination of the full source address and the logical creation time uniquely defines the message. Since we assume the chosen hash function SHA-256 to be collision resistant, *a message is uniquely determined by its hash*, so we can identify two messages if we know that their hashes coincide. |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
closes #1111