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

Deprecate all of the legacy log_ prefixed APIs. #3564

Merged
merged 1 commit into from Sep 30, 2023
Merged

Deprecate all of the legacy log_ prefixed APIs. #3564

merged 1 commit into from Sep 30, 2023

Conversation

jleibs
Copy link
Member

@jleibs jleibs commented Sep 29, 2023 •
edited

What

Changes the pattern slightly to:

Decorator

@deprecated(
    """Please migrate to `rr.log(…, rr.Arrows3D(…))`.
  See: https://www.rerun.io/docs/reference/migration-0-9 for more details."""
)

Docstring

    !!! Warning "Deprecated"
        Please migrate to [rerun.log][] with [rerun.Arrows3D][].

        See [the migration guide](https://www.rerun.io/docs/reference/migration-0-9) for more details.

Checklist

@jleibs jleibs marked this pull request as ready for review September 29, 2023 19:37
@jleibs jleibs added the 🐍 Python API Python logging API label Sep 29, 2023
@jleibs jleibs changed the title Add all the deprecation notices Deprecate all of the legacy log_ prefixed APIs. Sep 29, 2023
@jleibs jleibs mentioned this pull request Sep 29, 2023
Merged
3 tasks
@emilk emilk merged commit ec3644d into main Sep 30, 2023
29 of 35 checks passed
@emilk emilk deleted the jleibs/deprecate_legacy_loggers branch September 30, 2023 08:06
jleibs added a commit that referenced this pull request Oct 2, 2023
@jleibs
Update the python API docs site for the new APIs (#3565)
23dd97b 
### What
 - Builds on top of: #3564
 - Resolves: #3437
 
Replaces the logging functions with the archetypes.
Moves the deprecated function to their own section.

Also fixes the color inversion issue.

### 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 [demo.rerun.io](https://demo.rerun.io/pr/3565) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3565)
- [Docs
preview](https://rerun.io/preview/85bdc0990d13a21c0cf1c2385e6601af2a9edaf8/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/85bdc0990d13a21c0cf1c2385e6601af2a9edaf8/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emilk emilk emilk approved these changes

Assignees
No one assigned
Labels
include in changelog 🐍 Python API Python logging API
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mark old log_points style SDK as deprecated
2 participants
@jleibs @emilk