Include unit examples in codegen output #2509
Labels
codegen/idl
📖 documentation
Improvements or additions to documentation
🐍 Python API
Python logging API
🦀 Rust API
Rust logging API
Comments
teh-cmc
added
📖 documentation
3 tasks
teh-cmc
added a commit
that referenced
this issue
Jul 5, 2023
**Easier to review commit by commit** This PR makes it so that our nice examples in docs/code-examples automagically end up in docstrings for both Python & Rust. Fixes #2509 UPDATE: This also fixes a pretty serious bug in the versioning code... I'm not entirely how anything worked at all actually (??). TL;DR: given this: https://github.com/rerun-io/rerun/blob/0fc2a9fad2616bb3580176df37c488fc76a9a2ca/crates/re_types/definitions/rerun/archetypes/points2d.fbs#L16-L33 You get this  and this  ### What ### 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/2590) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/2590) - [Docs preview](https://rerun.io/preview/pr%3Acmc%2Fhope_docstring_examples/docs) - [Examples preview](https://rerun.io/preview/pr%3Acmc%2Fhope_docstring_examples/examples)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We now have really nice unit examples for both Python & Rust in
docs/code-examples; it would be great to provide a way to automatically include them as docstrings in the codegen output for both SDKs.The text was updated successfully, but these errors were encountered: