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.

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

Add README for internal crates #1451

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

Charles-Schleich
Copy link
Member

No description provided.

Copy link

PR missing one of the required labels: {'dependencies', 'enhancement', 'internal', 'new feature', 'documentation', 'bug', 'breaking-change'}

@Charles-Schleich Charles-Schleich added the documentation Improvements or additions to documentation label Sep 18, 2024
@OlivierHecart OlivierHecart merged commit 23af957 into eclipse-zenoh:dev/rustdoc Sep 19, 2024
7 of 11 checks passed
Mallets added a commit that referenced this pull request Sep 19, 2024
* Add unstable warning to zenoh-plugin-trait rustdoc

* Improve unstable warning

* Improve rustdoc

* Fix clippy

* Add README for internal crates (#1451)

* Remove style in unstable warning message

* Dev/rustdoc (#1455)

* Add README for internal crates

* add hardlinks for internal crate README, fix Type References in docs, workaround with `zenoh_macros::unstable` causing cargo doc to fail refeneces

* Restore single line summary behaviour

* fmt

* remove zenoh::prelude from Locality doc

* Add warning to shm module and crate doc

* Add internal warning to zenoh-config zenoh-keyexpr and zenoh-runtime crates doc

---------

Co-authored-by: Luca Cominardi <[email protected]>
Co-authored-by: Charles Schleich <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants