Zebra: Tracking: require docs in all Zebra modules

Created on 9 Jun 2020  路  3Comments  路  Source: ZcashFoundation/zebra

Some Zebra modules have !#[deny(missing_docs)], and some don't.

Let's require docs in all modules, so we don't forget to document our code:

  • [ ] tower-batch
  • [ ] tower-fallback
  • [x] zebra-chain
  • [ ] zebra-client
  • [ ] zebra-consensus
  • [x] zebra-network
  • [ ] zebra-rpc
  • [ ] zebra-script
  • [ ] zebra-state
  • [ ] zebra-test
  • [x] zebra-utils
  • [ ] zebrad
A-docs C-tracking-issue

Most helpful comment

Similarly, I think it might be a good idea to go over the available lints provided by rustc and clippy as part of a gardening session from time to time to see if there are other lints we'd want to enable across all our crates.

Do we have a TODO list for gardening?
Or a rotating list?

If not, let's start one.

All 3 comments

Similarly, I think it might be a good idea to go over the available lints provided by rustc and clippy as part of a gardening session from time to time to see if there are other lints we'd want to enable across all our crates.

Similarly, I think it might be a good idea to go over the available lints provided by rustc and clippy as part of a gardening session from time to time to see if there are other lints we'd want to enable across all our crates.

Do we have a TODO list for gardening?
Or a rotating list?

If not, let's start one.

Un-checked zebra-consensus, because we stopped requiring docs in #1043.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dconnolly picture dconnolly  路  3Comments

teor2345 picture teor2345  路  4Comments

yaahc picture yaahc  路  6Comments

hdevalence picture hdevalence  路  4Comments

dconnolly picture dconnolly  路  5Comments