Skip to content

Never direct users towards using rr.log_components #8151

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

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Nov 14, 2024

rr.log_components is a clunky implementation detail, at best. Users should be directed towards rr.log, always.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

To deploy documentation changes immediately after merging this PR, add the deploy docs label.

@teh-cmc teh-cmc added enhancement New feature or request 🐍 Python API Python logging API include in changelog labels Nov 14, 2024
Copy link

github-actions bot commented Nov 14, 2024

Latest documentation preview deployed successfully.

Result Commit Link
6a7bdd2 https://landing-fogfrohde-rerun.vercel.app/docs

Note: This comment is updated whenever you push a commit.

@teh-cmc
Copy link
Member Author

teh-cmc commented Nov 14, 2024

@rerun-bot full-check

Copy link

Started a full build: https://github.com/rerun-io/rerun/actions/runs/11841295496

Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

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

right, we made log handle this a while ago. What are cases where one would still need it actually? Should we deprecate it?

@teh-cmc
Copy link
Member Author

teh-cmc commented Nov 14, 2024

right, we made log handle this a while ago. What are cases where one would still need it actually? Should we deprecate it?

I thought about deprecating it at one point, but then realized that we ourselves ultimately delegate to it in order to actually log stuff... but now that I'm taking a closer look, it seems to be the exact same code as log() 🤦

I'll take a closer look -- if it is indeed the exact same code, I'll deprecate it too.

@teh-cmc
Copy link
Member Author

teh-cmc commented Nov 14, 2024

Nuh-uh, nevermind, they're not even close to the same, and it even makes sense as is 👍

@teh-cmc teh-cmc merged commit 376e8fe into main Nov 14, 2024
78 checks passed
@teh-cmc teh-cmc deleted the cmc/no_log_components branch November 14, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request include in changelog 🐍 Python API Python logging API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants