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

Ticktock add/subtract needs documentation #771

Open
jtniehof opened this issue Jul 23, 2024 · 0 comments
Open

Ticktock add/subtract needs documentation #771

jtniehof opened this issue Jul 23, 2024 · 0 comments
Assignees
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki)

Comments

@jtniehof
Copy link
Member

The examples for time hint at Ticktock operations but they aren't explicitly documented (and some of the examples aren't complete). These should be more completely documented. There are docstrings on some of the dunder methods but these aren't rendered by autosummary and we probably want to document the behavior rather than the implementation. Should wait for #759 but out of scope for it.

@jtniehof jtniehof added the documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) label Jul 23, 2024
@jongeorge1999 jongeorge1999 self-assigned this Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki)
Projects
None yet
Development

No branches or pull requests

2 participants