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

Generate component/datatype docs #3535

Merged
merged 18 commits into from Oct 2, 2023
Merged

Generate component/datatype docs #3535

merged 18 commits into from Oct 2, 2023

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Sep 29, 2023 •
edited by github-actions bot

What

Checklist

@jprochazk jprochazk added 📖 documentation Improvements or additions to documentation 🧑‍💻 dev experience developer experience (excluding CI) codegen/idl include in changelog labels Sep 29, 2023
@jprochazk jprochazk marked this pull request as ready for review September 29, 2023 09:52
emilk
emilk approved these changes Sep 29, 2023
View reviewed changes
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM

crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
crates/re_types_builder/src/codegen/docs/mod.rs Outdated Show resolved Hide resolved
@jprochazk
Copy link
Member Author

Added the warnings:
image

There's a bug right now where scalar types are not being recognized which I will promptly fix, but it's a good test :).

@jprochazk jprochazk removed the request for review from nikolausWest October 2, 2023 13:09
@jprochazk
Copy link
Member Author

As before, we can iterate on the content later

@jprochazk jprochazk merged commit 95ec36f into main Oct 2, 2023
30 checks passed
@jprochazk jprochazk deleted the jan/generate-component-docs branch October 2, 2023 13:40
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
codegen/idl 🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generate documentation for components/data types
2 participants
@jprochazk @emilk