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

Examples should display function inputs #153

Closed
AshlinHarris opened this issue Aug 5, 2022 · 3 comments
Closed

Examples should display function inputs #153

AshlinHarris opened this issue Aug 5, 2022 · 3 comments
Assignees
@AshlinHarris
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@AshlinHarris
Copy link
Contributor

The docstring examples for each function display the output DataFrame. The input DataFrames should also be displayed so that the user can see how the output relates to the input, especially for pivot().
@AshlinHarris AshlinHarris added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 5, 2022
@AshlinHarris
Copy link
Contributor Author

I think the best approach might be to change the definition of each input DataFrame so that it gets read from a text string that visually resembles a table. I think either DataFrames.jl or CSV.jl will have that functionality.

A quicker way to accomplish this would be to just include a printout of the Dataframe as a comment after it is declared in the docstring. The important thing is that the user can visually compare the input and output.

@AshlinHarris AshlinHarris mentioned this issue Aug 11, 2022
Closed
@AshlinHarris
Copy link
Contributor Author

Related: #176

@AshlinHarris AshlinHarris self-assigned this Aug 12, 2022
@AshlinHarris
Copy link
Contributor Author

#178

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AshlinHarris AshlinHarris

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AshlinHarris