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

Dev #27

Merged
merged 2 commits into from
Oct 26, 2023
Merged

Dev #27

merged 2 commits into from
Oct 26, 2023

Conversation

lindsaygelle
Copy link
Owner

Description

Added documentation to README.

Related Issue

Added missing package documentation and flourishes.

Changes Made

Created examples for the README file.

Checklist

  • I have followed the coding style guidelines of the project.
  • My code passes all existing unit tests.
  • I have added new unit tests to cover the changes where applicable.
  • I have updated the documentation to reflect the changes.
  • My changes do not introduce any new warnings or errors.
  • I have tested my changes thoroughly.

Additional Notes

Documentation might still change over time. Still finding a style I like.

lindsaygelle
lindsaygelle commented Oct 26, 2023
View reviewed changes
Copy link
Owner Author

@lindsaygelle lindsaygelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌵

@lindsaygelle lindsaygelle merged commit ebe314a into main Oct 26, 2023
6 checks passed
@lindsaygelle lindsaygelle deleted the dev branch October 26, 2023 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lindsaygelle