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

Update docstring and user guides #84

Merged
merged 7 commits into from
Dec 20, 2023
Merged

Update docstring and user guides #84

merged 7 commits into from
Dec 20, 2023

Conversation

Wh1isper
Copy link
Collaborator

@Wh1isper Wh1isper commented Dec 20, 2023

Description

Motivation and Context

How has this been tested?

Types of changes

  • Maintenance (no change in code, maintain the project's CI, docs, etc.)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Copy link
Contributor

sweep-ai bot commented Dec 20, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@Wh1isper Wh1isper marked this pull request as ready for review December 20, 2023 08:49
@Wh1isper Wh1isper merged commit e636c80 into main Dec 20, 2023
11 checks passed
@Wh1isper Wh1isper deleted the docs-docstring-update branch December 20, 2023 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant