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

Missing documentation for ImageEncoded and NV12 support #4820

Closed
nikolausWest opened this issue Jan 15, 2024 · 1 comment · Fixed by #4988
Closed

Missing documentation for ImageEncoded and NV12 support #4820

nikolausWest opened this issue Jan 15, 2024 · 1 comment · Fixed by #4988
Assignees
@Wumpf
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less
Milestone
0.13

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Jan 15, 2024 •
edited
Loading

The main documentation site is missing entries for rr.ImageEncoded. In the Python docs, there is an entry for rr.ImageEncoded, but the rr.FileFormat doesn't list any formats so it's impossible to find what encoding formats we support, including NV12

None of the documentation of TensorBuffer seems to mention that you can set kind = "nv12" either.
@nikolausWest nikolausWest added 🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 👀 needs triage This issue needs to be triaged by the Rerun team labels Jan 15, 2024
@nikolausWest nikolausWest added this to the 0.13 milestone Jan 15, 2024
@nikolausWest nikolausWest removed the 👀 needs triage This issue needs to be triaged by the Rerun team label Jan 15, 2024
@emilk emilk added the 🏎️ Quick Issue Can be fixed in a few hours or less label Jan 16, 2024
@oxkitsune oxkitsune mentioned this issue Jan 20, 2024
Merged
4 tasks
@jleibs
Copy link
Member

jleibs commented Jan 24, 2024 •
edited by Wumpf
Loading

Related:

@Wumpf Wumpf self-assigned this Jan 31, 2024
@Wumpf Wumpf mentioned this issue Jan 31, 2024
Merged
4 tasks
Wumpf added a commit that referenced this issue Feb 1, 2024
@Wumpf
Fill gaps in image encoding documentation, fix how python documents u…
a287d9c 
…nion variants (#4988)

### What

* Fixes #4820

Turned out union documentation didn't look great so I improved this a
bit

![image](https://github.com/rerun-io/rerun/assets/1220815/29367f7d-c3b3-4757-8e8a-8ecc18ae9cea)


### 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 the web demo (if applicable):
* Using newly built examples:
[app.rerun.io](https://app.rerun.io/pr/4988/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/4988/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/4988/index.html?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

- [PR Build Summary](https://build.rerun.io/pr/4988)
- [Docs
preview](https://rerun.io/preview/bc6f54745d7384b904466c2911ac2c93f42a3b53/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/bc6f54745d7384b904466c2911ac2c93f42a3b53/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Wumpf Wumpf

Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less
Projects
None yet
Milestone
0.13
Development

Successfully merging a pull request may close this issue.

Fill gaps in image encoding documentation, fix how python documents union variants rerun-io/rerun
4 participants
@emilk @Wumpf @nikolausWest @jleibs