-
Notifications
You must be signed in to change notification settings - Fork 0
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
Hide backend in API documentation #169
Comments
I will start working on this one. |
Changes to the documentation will be easier after we changed the package structure as proposed in #170. Will pause until that has happened. |
No, I'm not working on |
Now with the separation of |
I agree. I continued with #171, but I simply change the usage documentation by splitting it up into a section for users and one for developers. |
In #167 we introduce a new abstract interface layer between backends and the user. Which means a normal user will need to look only at the interface API. For that reason we should hide parts of the backend API from the user, e.g. all the methods that are inherited from
audbackend.Backend
inaudbackend.Artifactory
andaudbackend.FileSystem
and instead add a link to the interface section.It might still be of interest to show the API for
audbackend.Backend
as this is needed for developer who want to create a new interface.The text was updated successfully, but these errors were encountered: