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

reset_time and disable_timeline missing from Python docs #5255

Closed
roym899 opened this issue Feb 22, 2024 · 0 comments · Fixed by #5269
Closed

reset_time and disable_timeline missing from Python docs #5255

roym899 opened this issue Feb 22, 2024 · 0 comments · Fixed by #5269
Assignees
@Wumpf
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less

Comments

@roym899
Copy link
Collaborator

roym899 commented Feb 22, 2024

See: https://ref.rerun.io/docs/python/0.13.0/common/

Describe the bug
reset_time and disable_timeline are mentioned (at least the latter is); however, are missing from the API page.
@roym899 roym899 added 🪳 bug Something isn't working 👀 needs triage This issue needs to be triaged by the Rerun team labels Feb 22, 2024
@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less and removed 👀 needs triage This issue needs to be triaged by the Rerun team labels Feb 23, 2024
@Wumpf Wumpf self-assigned this Feb 23, 2024
@Wumpf Wumpf mentioned this issue Feb 23, 2024
Merged
5 tasks
Wumpf added a commit that referenced this issue Feb 24, 2024
@Wumpf
Add missing python docs for disable_timeline & reset_time (#5269)
de3d868 
### What

* Fixes #5255

<img width="867" alt="image"
src="https://github.com/rerun-io/rerun/assets/1220815/3863cf76-5983-408f-aa08-6a591b1d763f">


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using newly built examples:
[app.rerun.io](https://app.rerun.io/pr/5269/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/5269/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/5269/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5269)
- [Docs
preview](https://rerun.io/preview/d897164010027b66072c9bd38e3ec445692b137b/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/d897164010027b66072c9bd38e3ec445692b137b/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Wumpf Wumpf

Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add missing python docs for disable_timeline & reset_time rerun-io/rerun
2 participants
@Wumpf @roym899