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

Standardize smart contract NatSpec comment spelling to US English #465

Open
3 of 6 tasks
kyzooghost opened this issue Dec 18, 2024 · 0 comments
Open
3 of 6 tasks
Assignees
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation P3: Low Issue priority: low

Comments

@kyzooghost
Copy link
Contributor

Description

Standardize smart contract NatSpec comment spelling to US English

Motivation

docs.linea.build is predominantly US English spelling, so for better consistency with the existing Linea public documentation we want to standardize the spelling in the smart contract NatSpec comments to US English as well

Tasks

  • Standardize spelling of Linea smart contract NatSpec comments to US English

Acceptance criteria

  • Linea smart contract NatSpec comments standardized to US English

Risks

  • May disturb smart contract audit timing, in that we are currently holding back several smart contract PRs on account of the smart contract auditors

Remember to

  • Add the documentation label in case there is an impact on the documentation
  • Add priority and team labels
  • Add Task for updating the Runbook or adding/updating existing metrics and alerts.
@kyzooghost kyzooghost added Contracts Smart Contract related documentation Improvements or additions to documentation P3: Low Issue priority: low labels Dec 18, 2024
@kyzooghost kyzooghost self-assigned this Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation P3: Low Issue priority: low
Projects
None yet
Development

No branches or pull requests

1 participant