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

rr.log_cleared() is missing from the "Common API" section of the documentation #2348

Closed
abey79 opened this issue Jun 9, 2023 · 1 comment
Closed

rr.log_cleared() is missing from the "Common API" section of the documentation #2348

abey79 opened this issue Jun 9, 2023 · 1 comment
Labels
😤 annoying Something in the UI / SDK is annoying to use 🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less

Comments

@abey79
Copy link
Member

abey79 commented Jun 9, 2023

Describe the bug

rr.log_cleared() is missing from the "Common API" section of the documentation. It does show up when searching, in the "Package listing" section (under clear.py).

Happens both in 0.6 and HEAD version of the docs.
@abey79 abey79 added 🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 😤 annoying Something in the UI / SDK is annoying to use 🏎️ Quick Issue Can be fixed in a few hours or less labels Jun 9, 2023
@abey79 abey79 mentioned this issue Jun 12, 2023
Closed
10 tasks
@jleibs jleibs mentioned this issue Jun 12, 2023
Merged
3 tasks
emilk pushed a commit that referenced this issue Jun 13, 2023
@jleibs
Add log_cleared to the common index (#2400)
0e3c824 
### What
Help users discover the `log_cleared` API by adding it to the index.

Resolves:
 - #2348

TODO:
- [ ] After merging, this change should be cherry-picked into
`release-0.6` branch and documentation should be re-deployed.

### 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)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: {{ pr-build-summary }}

<!-- This comment will be replaced by a link to the documentation
preview -->
@emilk
Copy link
Member

emilk commented Jun 13, 2023

Closed by #2400

@emilk emilk closed this as completed Jun 13, 2023
jleibs added a commit that referenced this issue Jun 13, 2023
@jleibs
Add log_cleared to the common index (#2400)
36700ee 
### What
Help users discover the `log_cleared` API by adding it to the index.

Resolves:
 - #2348

TODO:
- [ ] After merging, this change should be cherry-picked into
`release-0.6` branch and documentation should be re-deployed.

### 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)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: {{ pr-build-summary }}

<!-- This comment will be replaced by a link to the documentation
preview -->
emilk pushed a commit that referenced this issue Jun 15, 2023
@jleibs @emilk
Add log_cleared to the common index (#2400)
77ed880 
### What
Help users discover the `log_cleared` API by adding it to the index.

Resolves:
 - #2348

TODO:
- [ ] After merging, this change should be cherry-picked into
`release-0.6` branch and documentation should be re-deployed.

### 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)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: {{ pr-build-summary }}

<!-- This comment will be replaced by a link to the documentation
preview -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
😤 annoying Something in the UI / SDK is annoying to use 🪳 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

No branches or pull requests
2 participants
@emilk @abey79