Skip to content

Describe what is and what is not part of the public API #57

@goerz

Description

@goerz

Public API is probably only the keyword arguments for optimize and the documented fields of the result object.

Some keyword argument could be marked as "experimental".

We can use @public to mark these, and make sure this is properly shown in the online documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions