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

make sure that important trait methods are easy to find #710

Closed
milyin opened this issue Feb 1, 2024 · 1 comment
Closed

make sure that important trait methods are easy to find #710

milyin opened this issue Feb 1, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@milyin
Copy link
Contributor

milyin commented Feb 1, 2024

This update #688 moves several key functions of Session to separate trait. Need to make sure that it's easy to navigate to this functionality in the documentation.
This is a problem in rust autogenerated documentation: methods of structure are considered important and visible immediately, but trait implementations are deep buried in lots of helping traits like Deref, Cloneand Display. If this happens, need to make sure that key traits like SessionDeclarations are linked from the structure description.

@milyin milyin added the documentation Improvements or additions to documentation label Feb 1, 2024
@Mallets Mallets added the release Part of the next release label Feb 1, 2024
@milyin milyin moved this to Backlog in Zenoh 1.0.0 release Feb 5, 2024
@milyin milyin self-assigned this Feb 5, 2024
@milyin milyin removed the release Part of the next release label Mar 12, 2024
@Mallets
Copy link
Member

Mallets commented Jul 4, 2024

Closed by #1193

@Mallets Mallets closed this as completed Jul 4, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Zenoh 1.0.0 release Jul 4, 2024
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
Status: Done
Development

No branches or pull requests

2 participants