Update the example in configure-viewer-through-code.md to use subclasses of SpaceView
#6092
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Wumpf
added
🪳 bug
Wumpf
approved these changes
Apr 24, 2024
|
cherry-picked it into |
Wumpf
pushed a commit
that referenced
this pull request
Apr 24, 2024
…ses of `SpaceView` (#6092) ### What Whereas the Python API docs say that we should use subclasses of `SpaceView` instead of `SpaceView` directly (see [here](https://ref.rerun.io/docs/python/0.15.1/common/blueprint_apis/#rerun.blueprint.SpaceView)), the [blueprint documentation](https://www.rerun.io/docs/howto/configure-viewer-through-code) uses `SpaceView` with a subclass as positional argument to the constructor of the `SpaceView`. Not only is this contradictory, the example that is currently in the online docs does not run for me in version 0.15.1, see the error below. ``` Traceback (most recent call last): File "rerun_blueprint_test.py", line 6, in <module> rrb.SpaceView(rrb.BarChartView()), TypeError: SpaceView.__init__() takes 1 positional argument but 2 were given ``` ### 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) * [ ] I have tested the web demo (if applicable): * Using examples from latest `main` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6092?manifest_url=https://app.rerun.io/version/main/examples_manifest.json) * Using full set of examples from `nightly` build: [rerun.io/viewer](https://rerun.io/viewer/pr/6092?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json) * [x] 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](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)! - [PR Build Summary](https://build.rerun.io/pr/6092) - [Recent benchmark results](https://build.rerun.io/graphs/crates.html) - [Wasm size tracking](https://build.rerun.io/graphs/sizes.html) To run all checks from `main`, comment on the PR with `@rerun-bot full-check`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Whereas the Python API docs say that we should use subclasses of
SpaceViewinstead ofSpaceViewdirectly (see here), the blueprint documentation usesSpaceViewwith a subclass as positional argument to the constructor of theSpaceView.Not only is this contradictory, the example that is currently in the online docs does not run for me in version 0.15.1, see the error below.
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.