-
Notifications
You must be signed in to change notification settings - Fork 33
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 some doc strings #342
Add some doc strings #342
Conversation
There were some other doc strings that I could have added but I was concerned about working on top of @MarcoGorelli ad @CommonClimate on changing code. |
Good thinking @kcpevey . Is this ready for review, then, or will you open another PR once we're done with code edits, so you can put in the other docstrings? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I might just change "pyleo_series" to "ts" in the load_dataset()
docstring, as we typically use that moniker for a Series, the same way pandas uses "df" for dataframe, even though anything is allowed.
Also, just saw the docstring for It should be:
Sorry to change this on you. So I guess this way of making docstrings does not take changes in the codebase into account. That is an argument for using ipython directives... |
I can make that change to this PR. Screen output for |
OK, I like that plan. Re: docstrings, the SeriesResampler will need a lot of explanation. Honestly, I still don't understand exactly how it works, and I doubt our users will. If applicable, you can link to this but also important to explain the differences. Or we may need a whole tutorial about how to use that class, preferably as a notebook in the paleopandas repo. We can then fold it into our PyleoTutorials. |
Also while waiting for tests to run I added a few "close figs"