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

Internal-only API reference for 'contributing' docs #212

Open
sadielbartholomew opened this issue May 17, 2021 · 0 comments
Open

Internal-only API reference for 'contributing' docs #212

sadielbartholomew opened this issue May 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sadielbartholomew
Copy link
Member

Only the public API is generally documented in the API reference, but for developers, those building libraries using cf-python, and anyone else potentially keen to know more about what goes on under-the-hood, without having to search through the codebase, it could be useful to have some developer documentation containing the API reference for internal objects. A sensible place to house that would be in some hierarchy under the existing 'Contributing' section.

See also #210 (comment) where a reference for the mixin classes is given as an example that could be useful.

@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label May 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant