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

Add documentation strings to all functions<Summarize the feature and how it should work> #259

Open
monroews opened this issue Jan 2, 2020 · 0 comments
Assignees
Labels
feature Feature request/addition low Low priority research_it Tasks for the Research IT subteam

Comments

@monroews
Copy link
Contributor

monroews commented Jan 2, 2020

The documentation string at the beginning of each function needs to include the function inputs. This is because it is this documentation that pops up in Colab and Colab no longer shows the function call with the list of inputs. See Numpy for an example of a well documented function with defined inputs.

I suggest going through all aguaclara functions and adding this documentation.

@monroews monroews added low Low priority feature Feature request/addition labels Jan 2, 2020
@HannahSi HannahSi added the research_it Tasks for the Research IT subteam label Feb 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature request/addition low Low priority research_it Tasks for the Research IT subteam
Projects
None yet
Development

No branches or pull requests

3 participants