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

Consistent use of argument types in API docs #546

Open
erimatnor opened this issue Oct 21, 2020 · 1 comment
Open

Consistent use of argument types in API docs #546

erimatnor opened this issue Oct 21, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@erimatnor
Copy link
Contributor

The API docs sometimes list the type of arguments given to some API functions, but this is not consistent. We should make sure we either document the types of all arguments or don't use this practice.
@erimatnor erimatnor added the enhancement New feature or request label Oct 21, 2020
@solugebefola
Copy link
Contributor

Yah, I'm working on a general template for API entries #482 including data types, please add comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@erimatnor @solugebefola