You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some sections in examples are much abstract and loose details.
ex: // === Public Functions ===, // ===== Entrypoints ===== are ambiguous for view or mutation, and the convention wants to show details about mutability.
Some sections are similar terms with the same meaning.
ex: // === Private Helpers ===, // === Test Helpers ===, // === Error codes ===, // === Admin-only functions ===, // === Tests ===, // === Internal ===
If the comment sections are well defined, I am happy to make a PR to modify these examples.
The text was updated successfully, but these errors were encountered:
In 2024 conventions, we defined comment sections.
https://docs.sui.io/concepts/sui-move-concepts/conventions
Some sections in examples are much abstract and loose details.
ex:
// === Public Functions ===
,// ===== Entrypoints =====
are ambiguous for view or mutation, and the convention wants to show details about mutability.Some sections are similar terms with the same meaning.
ex:
// === Private Helpers ===
,// === Test Helpers ===
,// === Error codes ===
,// === Admin-only functions ===
,// === Tests ===
,// === Internal ===
If the comment sections are well defined, I am happy to make a PR to modify these examples.
The text was updated successfully, but these errors were encountered: