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

Some of the members exposed in public API lack documentation. #385

Open
gdziadkiewicz opened this issue May 11, 2020 · 0 comments
Open

Some of the members exposed in public API lack documentation. #385

gdziadkiewicz opened this issue May 11, 2020 · 0 comments
Assignees
@gdziadkiewicz
Milestone
3.0.0

Comments

@gdziadkiewicz
Copy link
Collaborator

Description

We should try to document the whole public surface of the package. Relying solely on the name or parameter name or signature is not beginner-friendly and makes exploration of the package capabilities harder.

TODO: Create a list showing remaining work to be done to resolve this
@gdziadkiewicz gdziadkiewicz added this to the 3.0.0 milestone Oct 24, 2020
@gdziadkiewicz gdziadkiewicz self-assigned this Nov 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gdziadkiewicz gdziadkiewicz

Labels
None yet
Projects
None yet
Milestone
3.0.0
Development

No branches or pull requests
1 participant
@gdziadkiewicz