Update ERC-20: standardize Note formatting across function descriptions#1720
Open
0xAxiom wants to merge 1 commit into
Open
Update ERC-20: standardize Note formatting across function descriptions#17200xAxiom wants to merge 1 commit into
0xAxiom wants to merge 1 commit into
Conversation
Resolves ethereum#1529. Standardizes the inconsistent note formatting in ERC-20 function descriptions to use `**Note:**` (bold with colon) consistently: - transfer(): `*Note*` -> `**Note:**` - transferFrom(): `*Note*` -> `**Note:**` - approve(): `**NOTE**:` -> `**Note:**` Adopts Option 1 from the issue (bold with colon) for cleaner rendering and consistency with conventional Markdown idioms.
Collaborator
File
|
eip-review-bot
changed the title
|
The commit 1a8da38 (as a parent of 4573c60) contains errors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #1529.
The ERC-20 specification used inconsistent formatting for notes across function descriptions:
transfer()andtransferFrom():*Note*(italics, no colon)approve():**NOTE**:(bold all-caps with colon)This PR standardizes all three to Option 1 from the issue —
**Note:**(bold with colon) — which is the conventional Markdown idiom and renders cleanly without the shouting tone of all-caps.Changes
transfer()*Note***Note:**transferFrom()*Note***Note:**approve()**NOTE**:**Note:**Single file changed (
ERCS/erc-20.md), three small edits, no semantic content modified.