Need Rust docs on protocols::v2::subprotocols

[GitGab19]

Background

Currently, the protocols::v2::subprotocols has already been documented, but it's worth a look to see where to improve it. Since it contains 4 different crates, this issue is the tracker one, and more specific ones are going to be grouped here.

Note: While this issue addresses the need for doc comments, it will also serve as a means to identify code debt that needs to be cleaned up and addressed in future issues.

Solution

Navigate through each crate in protocols::v2::subprotocols and add:

• Rust Docs comments (following the formatting structure in this on-going discussion), to be displayed in docs.rs
• a descriptive README.md file to be displayed in crates.io

While this work is being performed, specific code debt should be looked for and recorded to turn into future issues

Task list

• common_messages_sv2: Need Rust docs on protocols::v2::subprotocols::common-messages #1203
• job_declaration_sv2: Need Rust docs on protocols::v2::subprotocols::job-declaration #1204
• mining_sv2: Need Rust docs on protocols::v2::subprotocols::mining #1205
• template_distribution_sv2: Need Rust docs on protocols::v2::subprotocols::template-distribution #1206

[plebhash]

closed via

• common_messages_sv2 docs #1242
• Job Declaration Documentation #1265
• mining_sv2 docs #1243
• Docs for Template Distribution Messages #1257