-
Notifications
You must be signed in to change notification settings - Fork 19
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
Prepare for the release #90
Conversation
Signed-off-by: Hugues de Valon <[email protected]>
0953128
to
100d6b7
Compare
src/core/basic_client.rs
Outdated
/// ```no_run | ||
///use parsec_client::BasicClient; | ||
///let mut client = BasicClient::new_naked(); | ||
///client.set_default_provider().unwrap(); | ||
/// ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these examples actually useful? I mean, you're literally just calling one method without any arguments on a newly created object, I don't think it actually adds anything to the documentation. The ones where the arguments are actually somewhat complex, or that need some setup are probably worth it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think so, it allows users to use the function in their code by just copying and pasting and they are sure it will compile. I also tend to think that even useless documentation/comment is better than nothing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've definitely not followed that guideline in many places - especially the TSS crate is littered with "how not why" examples.
Signed-off-by: Hugues de Valon <[email protected]>
Agree that some of the examples here are poor. I tried to make some of them better with more context and added links where they are the same. edit: will open an issue to finish this work and the methods I did not touch. |
Also updates the code documention to be up to date.