doc comments not matching with method return type

tikv / rust-prometheus

Prometheus instrumentation library for Rust applications

Apache License 2.0

1.07k stars 182 forks source link

doc comments not matching with method return type #432

Open keepsimple1 opened 2 years ago

keepsimple1 commented 2 years ago

https://github.com/tikv/rust-prometheus/blob/ac86a264223c8d918a43e739ca3c48bb4aaedb90/src/encoder/mod.rs#L19-L20

This method actually returns () if successful.

mxinden commented 2 years ago

Great catch. Mind sending in a patch @keepsimple1?

keepsimple1 commented 2 years ago

@mxinden please take a look at the linked PR when you have time? Thanks.

mxinden commented 2 years ago

Unfortunately I no longer have permissions on this repository to e.g. approve CI to run. (Not complaining, this is fine, I haven't been involved much recently :heart:.)

Maybe @lucab can help?