This is a continuation of the previous doc improvement efforts, doing a comprehensive pass through the whole codebase to check for missing or stale comments, inconsistently named variables or files, etc.
There are just two non-docs changes, though not "code" changes: moving structs out of interfaces, which are similar to those already in VaultTypes. (I could factor them out, like I did for the computeDynamicFee function, but that was a rename, while this is just moving a struct.)
Started with the interfaces package (which of course affected most of the others). Subsequent PRs will look at the other packages.
Type of change
[ ] Bug fix
[ ] New feature
[ ] Breaking change
[ ] Dependency changes
[X] Code refactor / cleanup
[ ] Optimization: [ ] gas / [ ] bytecode
[X] Documentation or wording changes
[ ] Other
Checklist:
[ ] The diff is legible and has no extraneous changes
[ ] Complex code has been commented, including external interfaces
[ ] Tests have 100% code coverage
[ ] The base branch is either main, or there's a description of how to merge
Description
This is a continuation of the previous doc improvement efforts, doing a comprehensive pass through the whole codebase to check for missing or stale comments, inconsistently named variables or files, etc.
There are just two non-docs changes, though not "code" changes: moving structs out of interfaces, which are similar to those already in VaultTypes. (I could factor them out, like I did for the computeDynamicFee function, but that was a rename, while this is just moving a struct.)
Started with the interfaces package (which of course affected most of the others). Subsequent PRs will look at the other packages.
Type of change
Checklist:
main, or there's a description of how to mergeIssue Resolution