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 missing rust docs #82

Closed
notmandatory opened this issue Aug 26, 2022 · 3 comments
Closed

Add missing rust docs #82

notmandatory opened this issue Aug 26, 2022 · 3 comments
Labels
good first issue Good for newcomers

Comments

@notmandatory
Copy link
Member

To find list of missing rust docs see:

% cargo build --all-features
   Compiling electrum-client v0.10.3 (/Users/steve/git/notmandatory/rust-electrum-client)
warning: missing documentation for a struct
 --> src/config.rs:5:1
  |
5 | pub struct Config {
  | ^^^^^^^^^^^^^^^^^
  |
note: the lint level is defined here
 --> src/lib.rs:1:9
  |
1 | #![warn(missing_docs)]
  |         ^^^^^^^^^^^^

warning: missing documentation for an associated function
   --> src/config.rs:101:5
    |
101 |     pub fn socks5(&self) -> &Option<Socks5Config> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for an associated function
   --> src/config.rs:104:5
    |
104 |     pub fn retry(&self) -> u8 {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for an associated function
   --> src/config.rs:107:5
    |
107 |     pub fn timeout(&self) -> Option<Duration> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for an associated function
   --> src/config.rs:110:5
    |
110 |     pub fn validate_domain(&self) -> bool {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for an associated function
   --> src/config.rs:114:5
    |
114 |     pub fn builder() -> ConfigBuilder {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for a type alias
  --> src/types.rs:20:1
   |
20 | pub type Call = (String, Vec<Param>);
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: `electrum-client` (lib) generated 7 warnings
@notmandatory notmandatory added the good first issue Good for newcomers label Aug 26, 2022
@sansosti
Copy link

Hi there,
I was looking for issues to contribute with but I think this one can be closed now?

@oleonardolima
Copy link
Collaborator

Hi there, I was looking for issues to contribute with but I think this one can be closed now?

Thanks for looking into contributing to the project! I think another interesting issue would be #142, if you see fit.

Yes, AFAICT it's already been solved by #94.

@oleonardolima
Copy link
Collaborator

Closed by #94

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants