sbtc-developer-release icon indicating copy to clipboard operation
sbtc-developer-release copied to clipboard

Published 20 hours ago • verified publisher icon stacks-network

Documentation - go wild on doc comments

Open stjepangolemac opened this issue 2 years ago • 6 comments

Let's try to make the crates from this workspace documented in the best way possible.

Here are some crates with very good documentation:

  • https://docs.rs/rkyv/latest/rkyv/
  • https://docs.rs/glommio/latest/glommio/
  • https://docs.rs/clap/latest/clap/
  • https://docs.rs/axum/latest/axum/

The packages that would benefit the most from this are stacks-core and sbtc-core.

stjepangolemac avatar Jul 25 '23 16:07 stjepangolemac

Not yet done.

stjepangolemac avatar Aug 03 '23 13:08 stjepangolemac

Is this still being worked on?

AshtonStephens avatar Oct 03 '23 15:10 AshtonStephens

I think not actionable enough...

friedger avatar Oct 03 '23 15:10 friedger

I've extended the description to emphasize that we need this for stacks-core and sbtc-core. I'd classify this as low priority but good to have.

stjepangolemac avatar Oct 09 '23 12:10 stjepangolemac

@stjepangolemac I'd like to help with this one, if that's okay. Is this referring to docs on all mods and fns? If so, should only pub fns be documented?

ldiego08 avatar Jun 03 '24 17:06 ldiego08

@stjepangolemac I'd like to help with this one, if that's okay. Is this referring to docs on all mods and fns? If so, should only pub fns be documented?

cc/ @AshtonStephens

diwakergupta avatar Jun 03 '24 17:06 diwakergupta