Skip to content

Commit

Permalink
Add log_cleared to the common index (#2400)
Browse files Browse the repository at this point in the history
### 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 -->
  • Loading branch information
jleibs committed Jun 13, 2023
1 parent bd97617 commit 36700ee
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions rerun_py/docs/gen_common_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,11 @@ class Section:
# "LogLevel", "LoggingHandler"
func_list=["log_text_entry"],
),
Section(
title="Clearing Entities",
module_summary=None,
func_list=["log_cleared"],
),
Section(
title="Helpers",
module_summary="script_helpers",
Expand Down

0 comments on commit 36700ee

Please sign in to comment.