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

Documentation: Add Detailed Examples for All Scripts #31

Open
berntpopp opened this issue Jun 21, 2024 · 0 comments
Open

Documentation: Add Detailed Examples for All Scripts #31

berntpopp opened this issue Jun 21, 2024 · 0 comments
Assignees
@berntpopp
Labels
documentation Improvements or additions to documentation

Comments

@berntpopp
Copy link
Member

Provide comprehensive examples for each script in the repository. This documentation should include step-by-step instructions and cover common use cases to assist users in understanding and utilizing the scripts.

Acceptance Criteria:

  • Write detailed examples for each script.
  • Include explanations and expected outputs for each example.
  • Add these examples to the appropriate section of the README or a dedicated documentation file.
@berntpopp berntpopp added the documentation Improvements or additions to documentation label Jun 21, 2024
@berntpopp berntpopp self-assigned this Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@berntpopp berntpopp

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@berntpopp