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

Enhance documentation with NatSpec for increased readability and for autogeneration of related docs #653

Open
19 tasks
zerosnacks opened this issue Feb 4, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@zerosnacks
Copy link
Member

zerosnacks commented Feb 4, 2025

Related: foundry-rs/book#1303

To do:

  • Interfaces
  • Base.sol
  • console.sol
  • console2.sol
  • safeconsole.sol
  • Script.sol
  • StdAssertions.sol
  • StdChains.sol
  • StdCheats.sol
  • StdError.sol
  • StdInvariant.sol
  • StdJson.sol
  • StdMath.sol
  • StdStorage.sol
  • StdStyle.sol
  • StdToml.sol
  • StdUtils.sol
  • Test.sol
  • Vm.sol

Goals:

  • Document all public facing functions with @notice
  • Mark private variables and functions with underscore prefix
  • Unify layouts to follow common best practices of grouping storage variables
  • Move internal functions up, private functions down
  • Should not modify any user facing function or interface

This will make it easier to autogenerate documentation that we can then load into https://book.getfoundry.sh/reference/forge-std/ and keep it up to date

@zerosnacks zerosnacks self-assigned this Feb 4, 2025
@zerosnacks zerosnacks changed the title Enhance documentation for increased readability and for autogeneration of related docs Enhance documentation with NatSpec for increased readability and for autogeneration of related docs Feb 4, 2025
@zerosnacks zerosnacks transferred this issue from foundry-rs/book Feb 4, 2025
zerosnacks added a commit that referenced this issue Feb 4, 2025
@zerosnacks zerosnacks added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Status: No status
Development

No branches or pull requests

1 participant