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

Document STD Crate #357

Open
crnbarr93 opened this issue Mar 25, 2024 — with Linear · 0 comments
Open

Document STD Crate #357

crnbarr93 opened this issue Mar 25, 2024 — with Linear · 0 comments
Assignees
@crnbarr93
Labels
Improvement

Comments

@crnbarr93 Linear
Copy link
Contributor

crnbarr93 commented Mar 25, 2024 •
edited
Loading

Description

Currently our STD crate is heavily undocumented, making it difficult to use for external developers. This is true both in terms of commenting but also in terms of READMEs, especially for our feature heavy modules.

Implementation

We should make sure to comment all public facing methods and add READMEs for the following:

  • STD Package
  • ADO Base
  • ADO Contract
  • Permissioning
  • Ownership

Acceptance Criteria

  • All public facing methods are commented
  • Additional READMEs for the listed modules
@crnbarr93 crnbarr93 added the Improvement label Mar 25, 2024 — with Linear
@crnbarr93 crnbarr93 self-assigned this Mar 26, 2024
@crnbarr93 crnbarr93 changed the title [RC] Document STD Crate Document STD Crate Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@crnbarr93 crnbarr93

Labels
Improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@crnbarr93