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.

Sign up for GitHub

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

Jump to bottom

Push comments/docs into interfaces #175

Open
Quazia opened this issue Aug 17, 2023 · 1 comment
Open

Push comments/docs into interfaces #175

Quazia opened this issue Aug 17, 2023 · 1 comment
Labels
cleanup non-feature or testing refactors focused on improving code readability and cleanliness

Comments

@Quazia
Copy link
Member

Quazia commented Aug 17, 2023

The code will look cleaner if we push all our comments and doc strings into the contract interfaces and just leverage the @inheritdoc tag. I'd do this after we sort them, we could also sort the interface functions alphabetically, but I'm not strongly opinionated on that. I think after visibility sorting either functionality sorting, or alphabetical sorting make equal sense.

Should be handled after #174
@waynehoover
Copy link
Contributor

Alphabetically sounds good to me.

@Quazia Quazia mentioned this issue Aug 17, 2023
Merged
@Quazia Quazia added the cleanup non-feature or testing refactors focused on improving code readability and cleanliness label Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup non-feature or testing refactors focused on improving code readability and cleanliness
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@waynehoover @Quazia