Skip to content

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

Open
@wangvsa

Description

@wangvsa
  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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions