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.

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

Closed
hagenw opened this issue Jan 23, 2024 · 6 comments · Fixed by #171
Closed

Hide backend in API documentation #169

hagenw opened this issue Jan 23, 2024 · 6 comments · Fixed by #171

Comments

@hagenw
Copy link
Member

hagenw commented Jan 23, 2024

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 in audbackend.Artifactory and audbackend.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.

@hagenw
Copy link
Member Author

hagenw commented Jan 23, 2024

I will start working on this one.

@hagenw
Copy link
Member Author

hagenw commented Jan 23, 2024

Changes to the documentation will be easier after we changed the package structure as proposed in #170. Will pause until that has happened.

@frankenjoe
Copy link
Collaborator

@hagenw are you working on #170? Otherwise I can also do it.

@hagenw
Copy link
Member Author

hagenw commented Jan 23, 2024

No, I'm not working on audbackend at the moment, feel free to start with #170.

@frankenjoe
Copy link
Collaborator

Now with the separation of backend and interface, I'm not completely convinced if we still have to hide parts of audbackend.backend.* in the API. Maybe it's sufficient if we add a note that he sub-module is only relevant for developers?

@hagenw
Copy link
Member Author

hagenw commented Jan 24, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants