Skip to content
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

Example comment section may not follow 2024 conventions #20249

Open
yanganto opened this issue Nov 13, 2024 · 0 comments
Open

Example comment section may not follow 2024 conventions #20249

yanganto opened this issue Nov 13, 2024 · 0 comments
Assignees
Labels
doc-issue Issue submitted using the Doc issue template

Comments

@yanganto
Copy link
Contributor

yanganto commented Nov 13, 2024

In 2024 conventions, we defined comment sections.
https://docs.sui.io/concepts/sui-move-concepts/conventions

    // === Imports ===
    // === Errors ===
    // === Constants ===
    // === Structs ===
    // === Method Aliases ===
    // === Public-Mutative Functions ===
    // === Public-View Functions ===
    // === Admin Functions ===
    // === Public-Package Functions ===
    // === Private Functions ===
    // === Test Functions ===

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.

@yanganto yanganto added the doc-issue Issue submitted using the Doc issue template label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-issue Issue submitted using the Doc issue template
Projects
None yet
Development

No branches or pull requests

2 participants