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

Create/update all documentation #43

Open
rfrenchseti opened this issue Jul 31, 2024 · 0 comments
Open

Create/update all documentation #43

rfrenchseti opened this issue Jul 31, 2024 · 0 comments
Assignees
@juzen2003
Labels
A-Big Project B-Documentation Effort 1 Hard Priority 4 Useful

Comments

@rfrenchseti
Copy link
Collaborator

pdsfile needs substantial additional documentation. This includes:

  • Google-style docstrings for every class and method with complete descriptions of what the class/method does.
  • Top-level architecture documentation describing how pdsfile works.
  • Documentation describing how to write a rules file for a new volume/bundle.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@juzen2003 juzen2003

Labels
A-Big Project B-Documentation Effort 1 Hard Priority 4 Useful
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rfrenchseti @juzen2003