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

it's not clear what is public zenoh API just by looking at sources #868

Closed
milyin opened this issue Mar 27, 2024 · 2 comments
Closed

it's not clear what is public zenoh API just by looking at sources #868

milyin opened this issue Mar 27, 2024 · 2 comments
Labels
release Part of the next release

Comments

@milyin
Copy link
Contributor

milyin commented Mar 27, 2024

Describe the release item

All zenoh modules in lib.rs are exported as public (pub mod session, etc)
Module prelude and root lib.rs reexports some of entities, but not all of them. This makes not clear for user what to import. Rust-analyzer shows multiple pieces of advice for same name.

I think to make things in order it makes sense to do these steps:

  1. in "lib.rs" remove all pub from mod declarations
  2. explicitly reexport public API from single place (prelude and lib.rs)

This will make API observable when looking at sources

@milyin milyin added the release Part of the next release label Mar 27, 2024
@milyin
Copy link
Contributor Author

milyin commented Mar 27, 2024

The task #806 is actually subtask of this

@milyin
Copy link
Contributor Author

milyin commented May 28, 2024

Done in dev/1.0.0 branch by reexporting all API through lib.rs

@milyin milyin closed this as completed May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Part of the next release
Projects
Status: Done
Development

No branches or pull requests

1 participant