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

Align the ordering of class methods #289

Open
dmdunla opened this issue Nov 5, 2023 · 1 comment
Open

Align the ordering of class methods #289

dmdunla opened this issue Nov 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
v2.0.0

Comments

@dmdunla
Copy link
Collaborator

dmdunla commented Nov 5, 2023

We should decide on the order of the class methods. Unless there is standard ordering that we should follow, below is a suggestion.

Suggestion:

  • __init__
  • from_* class methods
  • methods in alphabetical order
  • dunder (__<foo>__) methods in alphabetical order

Currently the method orderings are different across the classes.
@dmdunla dmdunla added the documentation Improvements or additions to documentation label Nov 5, 2023
@dmdunla dmdunla added this to the v2.0.0 milestone Nov 5, 2023
@jeremy-myers
Copy link
Collaborator

I think this ordering is intuitive. I can take this on after a second opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
2 participants
@jeremy-myers @dmdunla