Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

NatSpec, Comments, and Standards #109

Merged
merged 5 commits into from
Feb 17, 2024

Conversation

jdubpark
Copy link
Contributor

@jdubpark jdubpark commented Feb 17, 2024

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)

(replaces #98) (No modifications of existing logics or interface parameters are proposed here)

@LeoHChen LeoHChen requested a review from a team February 17, 2024 06:47
Copy link
Contributor

@kingster-will kingster-will left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General LGTM!

@LeoHChen LeoHChen merged commit 684df9c into storyprotocol:main Feb 17, 2024
1 check passed
kingster-will referenced this pull request in kingster-will/protocol-core-v1-dev Mar 19, 2024
* refactor: natspec, variable names, interface public funcs, comments, lints
* fix: variable name typos
* style: lint
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants