-
Notifications
You must be signed in to change notification settings - Fork 7
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
Documentation for AmpAndLengthScale
mentions internal attributes
#32
Comments
I think this is an interesting issue and I'm not sure what the best approach is. On the one hand, I don't think those attributes should be public; they should only be referenced within the class (or classes that inherit from |
I've had quite a few discussion about this and I'm afraid there is no right answer here. My recommendation is the following: every public attribute or method of a class, i.e. no leading underscore, should have a proper use case for someone using that class. This also entails that the functionality is documented. Your case might be a little special due to the fact that we are talking about an ABC here. I think it comes down to a matter of style, so I don't consider this a blocker. Feel free to close this with or without "fix". |
That makes sense, and thinking about this made me decide to redesign this part of the code. I think calling them |
If
amplitude
and_length_scale
should be public, we should remove the leading underscore. Otherwise they should be removed from the documentation.The text was updated successfully, but these errors were encountered: