-
Notifications
You must be signed in to change notification settings - Fork 85
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
Add a public API specification #327
Conversation
So if for example |
It means the constructor, any listed methods/attributes, and all methods/attributes listed in superclasses are public. |
Would it be clearer (if a bit verbose) to explicitly list everything for each class? |
Well, what if I want one or two methods/attributes not being part of the API? |
Then you don't list them in the API spec. |
By "listed" I mean "listed in the API spec". |
Sure, do I need to list all the other methods/attributes then? |
Yes, and this makes it clear that I should convert it so that every method/attribute is explicitly listed directly in the list for that class instead of expecting users to check the superclass' list. |
New version has several changes:
@vpodzime please check to see if I missed anything in the new LVM classes. |
Isn't What about |
Sphinx' mocking doesn't work for us since the objects aren't subscriptable, which is a problem for the parted fileSystemType attributes in format classes. We haven't had working docs on RTD for a long time anyway, so just drop all of this crud for now.
Latest version includes the following changes:
|
You can see a preview of the docs here. |
It is, right now, but will users of the API know? And is it going to stay like that in the future? I imagine us using e.g.
Good catch! These too, plus |
Looks good to me otherwise. |
All but the top/first section are subsections of it.
Add a public API specification
Where a class is listed that means instantiating that class is supported. Where is it not, we are specifying the public methods and attributes. There are some issues with undocumented members and singletons, but they are minor.