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

Cleanup, document, natspec for contract #150

Merged
merged 26 commits into from
Dec 13, 2022

Conversation

0xAlcibiades
Copy link
Member

No description provided.

@0xAlcibiades 0xAlcibiades changed the base branch from master to audit-fixes December 12, 2022 19:21
@codecov-commenter
Copy link

codecov-commenter commented Dec 12, 2022

Codecov Report

Merging #150 (97c9b87) into audit-fixes (a78ca48) will decrease coverage by 0.12%.
The diff coverage is 100.00%.

@@               Coverage Diff               @@
##           audit-fixes     #150      +/-   ##
===============================================
- Coverage        88.94%   88.82%   -0.13%     
===============================================
  Files                2        2              
  Lines              371      367       -4     
  Branches            56       56              
===============================================
- Hits               330      326       -4     
  Misses              31       31              
  Partials            10       10              
Impacted Files Coverage Δ
src/TokenURIGenerator.sol 71.09% <ø> (ø)
src/OptionSettlementEngine.sol 98.32% <100.00%> (-0.03%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

src/OptionSettlementEngine.sol Show resolved Hide resolved
src/OptionSettlementEngine.sol Show resolved Hide resolved
src/OptionSettlementEngine.sol Outdated Show resolved Hide resolved
src/OptionSettlementEngine.sol Outdated Show resolved Hide resolved
src/interfaces/IOptionSettlementEngine.sol Outdated Show resolved Hide resolved
@neodaoist
Copy link
Contributor

Additional — personally I would remove subheaders in Events, doesn't add that much imo.

If keeping them, need to move OptionsWritten to top section

Subheaders in Errors adds more value, but needs more categories, they're wrong/incomplete now.

@0xAlcibiades 0xAlcibiades changed the title WIP: Cleanup, document, natspec for contract Cleanup, document, natspec for contract Dec 13, 2022
@0xAlcibiades
Copy link
Member Author

@neodaoist we can do subheaders and reorder in a follow on PR.

@0xAlcibiades 0xAlcibiades merged commit 378e0ad into audit-fixes Dec 13, 2022
@0xAlcibiades 0xAlcibiades deleted the chore/contract_comments_natspec_ontology branch December 13, 2022 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants