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.

Sign up for GitHub

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

Jump to bottom

Tracking: require docs in all Zebra crates #453

Closed
17 of 29 tasks
teor2345 opened this issue Jun 9, 2020 · 4 comments
Closed
17 of 29 tasks

Tracking: require docs in all Zebra crates #453

teor2345 opened this issue Jun 9, 2020 · 4 comments
Labels
A-docs Area: Documentation C-tracking-issue Category: This is a tracking issue for other tasks

Comments

@teor2345
Copy link
Contributor

teor2345 commented Jun 9, 2020 •
edited by mpguerra
Loading

Motivation

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

Solution

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

Public API

  • tower-batch
  • tower-fallback
  • zebra-chain
  • zebra-client
  • zebra-consensus
    • block::VerifyBlockError
    • checkpoint::VerifyCheckpointError
  • zebra-network
  • zebra-rpc
  • zebra-script
  • zebra-state
  • zebra-test
    • command
    • prelude
    • transcript
    • vectors
  • zebra-utils
  • zebrad
    • components
      • mempool
      • sync
      • tokio
      • tracing

Other Doc Improvements

Enable and fix the following lints:

Optionally, require documentation for some private APIs:
@teor2345 teor2345 added A-docs Area: Documentation Poll::Ready labels Jun 9, 2020
@teor2345 teor2345 added this to the Validate transactions. milestone Jun 9, 2020
@yaahc
Copy link
Contributor

yaahc commented Jun 9, 2020

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.

@teor2345
Copy link
Contributor Author

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.

@yaahc yaahc removed this from the Validate transactions. milestone Jul 2, 2020
@dconnolly dconnolly added the C-tracking-issue Category: This is a tracking issue for other tasks label Aug 13, 2020
@dconnolly dconnolly changed the title Require docs in all Zebra modules Tracking: require docs in all Zebra modules Aug 13, 2020
@teor2345
Copy link
Contributor Author

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

@teor2345 teor2345 added this to the Block Validation milestone Sep 29, 2020
@teor2345 teor2345 mentioned this issue Oct 28, 2020
Closed
7 tasks
@mpguerra mpguerra removed this from the Block Validation milestone Jan 5, 2021
@mpguerra mpguerra removed the E-easy label Mar 23, 2021
@mpguerra mpguerra added the Epic Zenhub Label. Denotes a theme of work under which related issues will be grouped label May 25, 2021
@teor2345 teor2345 changed the title Tracking: require docs in all Zebra modules Tracking: require docs in all Zebra crates Jun 2, 2021
@teor2345 teor2345 mentioned this issue Jun 2, 2021
Merged
1 task
This was referenced Oct 17, 2021
Closed
Closed
@mpguerra mpguerra removed the Epic Zenhub Label. Denotes a theme of work under which related issues will be grouped label Jan 21, 2022
@teor2345
Copy link
Contributor Author

This is something we can do on an ongoing basis, rather than holding a ticket open for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation C-tracking-issue Category: This is a tracking issue for other tasks
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@hdevalence @dconnolly @mpguerra @yaahc @teor2345