Skip to content

expose CFTimeIndex to public API #2141

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
Merged
merged 2 commits into from
May 16, 2018
Merged

expose CFTimeIndex to public API #2141

merged 2 commits into from
May 16, 2018

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented May 16, 2018

cc @spencerkclark and @shoyer

jhamman
jhamman commented May 16, 2018
View reviewed changes
doc/api.rst
:toctree: generated/

CFTimeIndex

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open to suggestions on where to put this and what to call the heading.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine for now.

shoyer
shoyer reviewed May 16, 2018
View reviewed changes
xarray/coding/cftimeindex.py Outdated
@@ -135,6 +135,7 @@ def assert_all_valid_date_type(data):


class CFTimeIndex(pd.Index):
"""Custom Index for working with CF calendars and dates """
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add something like "All elements of a CFTimeIndex must be cftime.datetime objects."

spencerkclark
spencerkclark approved these changes May 16, 2018
View reviewed changes
Copy link
Member

@spencerkclark spencerkclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jhamman and @shoyer, this looks good to me too.

@jhamman jhamman merged commit 4972dfd into pydata:master May 16, 2018
@jhamman jhamman mentioned this pull request May 16, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shoyer shoyer shoyer approved these changes

@spencerkclark spencerkclark spencerkclark approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Exposing/documenting CFTimeIndex as public API
3 participants
@jhamman @shoyer @spencerkclark