Skip to content

Inconsistent formatting of notes in function documentation #1529

@Carlosssr

Description

@Carlosssr

The ERC20 specification documentation uses inconsistent formatting for notes across different function descriptions:

transfer() and transferFrom(): Uses "Note" (capitalized, no colon)
approve(): Uses "NOTE:" (all caps with colon)

Current Examples
transfer() and transferFrom():
Note Transfers of 0 values MUST be treated as normal transfers and fire the Transfer event.
approve():
NOTE: To prevent attack vectors like the one described here...
Proposed Solution
Standardize the note formatting across all functions.

Suggested format:
Option 1: Use "Note:" (bold with colon)
Note: Transfers of 0 values MUST be treated as normal transfers...
Option 2: Use "NOTE:" (all caps with colon) consistently
NOTE: Transfers of 0 values MUST be treated as normal transfers...
Impact

Improves documentation consistency
Enhances readability
Maintains professional documentation standards
Better developer experience

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions