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

Mark old log_points style SDK as deprecated #3275

Closed
nikolausWest opened this issue Sep 11, 2023 · 1 comment · Fixed by #3564
Closed

Mark old log_points style SDK as deprecated #3275

nikolausWest opened this issue Sep 11, 2023 · 1 comment · Fixed by #3564
Assignees
@jleibs
Labels
🐍 Python API Python logging API
Milestone
0.9 - Codegen, Ty...

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Sep 11, 2023 •
edited by emilk
Loading

The old Python api's in the log_points style should be marked as @deprecated in 0.9 before being removed in 0.10. Each depreciated function should include a description of what to use instead.
@nikolausWest nikolausWest added the 🐍 Python API Python logging API label Sep 11, 2023
@emilk emilk changed the title Mark old log_points style SDK as depreciated Mark old log_points style SDK as deprecated Sep 11, 2023
@jleibs jleibs self-assigned this Sep 26, 2023
@Wumpf
Copy link
Member

Wumpf commented Sep 29, 2023

Pattern established in #3500. Still need to actually do this for all functions

@jleibs jleibs mentioned this issue Sep 29, 2023
Merged
3 tasks
emilk pushed a commit that referenced this issue Sep 30, 2023
@jleibs
Deprecate all of the legacy log_ prefixed APIs. (#3564)
ec3644d 
### What
 - Resolves: #3275
 - Follows the pattern from #3500

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
* [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/3564) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3564)
- [Docs
preview](https://rerun.io/preview/c8edbef741ce60416de3915755e21ffabf133c14/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/c8edbef741ce60416de3915755e21ffabf133c14/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@teh-cmc teh-cmc mentioned this issue Oct 11, 2023
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jleibs jleibs

Labels
🐍 Python API Python logging API
Projects
None yet
Milestone
0.9 - Codegen, Type Oriented Api
Development

Successfully merging a pull request may close this issue.

Deprecate all of the legacy log_ prefixed APIs. rerun-io/rerun
3 participants
@Wumpf @nikolausWest @jleibs