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

Separating public and private APIs into different sections/pages in the documentation. #156

Open
wangvsa opened this issue Oct 13, 2023 · 0 comments
Open

Separating public and private APIs into different sections/pages in the documentation. #156

wangvsa opened this issue Oct 13, 2023 · 0 comments
Labels
priority: low Low priority type: documentation Improvements or additions to documentation

Comments

@wangvsa
Copy link
Collaborator

wangvsa commented Oct 13, 2023

  1. Check the API page and make sure it documents only the public APIs.
  2. Put all private/internal APIs in the developer documentation.
  3. Both the publication documentation and the developer documentation have a "developers note" section. Merge them.
    https://pdc.readthedocs.io/en/latest/api.html#developers-notes
  4. Suggestion: add a "naming convention" section in the developer documentation.
@wangvsa wangvsa added type: documentation Improvements or additions to documentation priority: low Low priority labels Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority: low Low priority type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wangvsa