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.

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

Need Rust docs on protocols::v2::subprotocols::job-declaration #1204

Closed
GitGab19 opened this issue Oct 11, 2024 · 0 comments · Fixed by #1265
Closed

Need Rust docs on protocols::v2::subprotocols::job-declaration #1204

GitGab19 opened this issue Oct 11, 2024 · 0 comments · Fixed by #1265
Assignees
Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic
Milestone

Comments

@GitGab19
Copy link
Collaborator

Background

Currently, the protocols::v2::subprotocols::job-declaration has already been documented, but it's worth a look to see where to improve it.

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.

Problem

When a user navigates to this crate crates.io, there is no useful information for the user. This impedes understanding and adoption.

Solution

Navigate through each crate in protocols::v2::subprotocols::job-declaration 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

@GitGab19 GitGab19 added documentation Improvements or additions to documentation protocols Lowest level protocol logic labels Oct 11, 2024
@GitGab19 GitGab19 added this to the 1.2.0 milestone Oct 11, 2024
@GitGab19 GitGab19 changed the title Need Rust docs on protocols::v2::subprotocols::job-declaration Need Rust docs on protocols::v2::subprotocols::job-declaration Oct 11, 2024
@plebhash plebhash assigned GitGab19 and jbesraa and unassigned GitGab19 Oct 11, 2024
@GitGab19 GitGab19 moved this from Todo 📝 to Ready For Review 🔍 in SV2 Roadmap 🛣️ Dec 3, 2024
@github-project-automation github-project-automation bot moved this from Ready For Review 🔍 to Done ✅ in SV2 Roadmap 🛣️ Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants