NatSpec, Comments, and Standards #98

jdubpark · 2024-02-16T10:02:11Z

This PR lints and polishes the style and formatting of the codebase using NasSpec.

NatSpec formatting for all functions
Variable names are standardized (no _ prefix or suffix unless name conflict is absolutely unavoidable)
Hides admin-only public functions in the interfaces
Add functions to interfaces that were previously not added or erroneously added.
Linting (prettier + solhint)

…natspec

jdubpark added 6 commits February 16, 2024 03:56

fix: access control a module setter

bcb2aaf

fix: natspec, var names and states, structs in interfaces

1fc0aa7

fix(test): var names and states, inits, getters, interfaces

99eb2f1

config: allow unused vars to allowunused param vars, to compile with …

4bbb36f

…natspec

style: solhint

4bc5195

fix: reflect main on IResolver change

caa2519

jdubpark force-pushed the core-natspec branch from 8a12e27 to caa2519 Compare February 16, 2024 10:45

jdubpark changed the title ~~Natspec~~ NatSpec, Comments, and Standards Feb 17, 2024

jdubpark requested review from a team and removed request for a team February 17, 2024 06:32

jdubpark mentioned this pull request Feb 17, 2024

NatSpec, Comments, and Standards #109

Merged

jdubpark closed this Feb 17, 2024

Provide feedback