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

Add missing documentation to the test module #100

Merged
merged 9 commits into from
Nov 11, 2024

Conversation

theEvilReaper
Copy link

Proposed changes

The testing module currently lacks documentation in several classes. This pull request adds the missing documentation to improve clarity and maintainability

Types of changes

What types of changes does your code introduce to this project?
Put an x in the boxes that apply

  • Bugfix (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)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before
merging your code.

  • I have read the CONTRIBUTING.md
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

@theEvilReaper theEvilReaper requested a review from a team as a code owner November 11, 2024 20:20
@github-actions github-actions bot added documentation Improvements or additions to documentation Feature labels Nov 11, 2024
Copy link
Collaborator

@TheMeinerLP TheMeinerLP left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

@theEvilReaper theEvilReaper merged commit b63f386 into master Nov 11, 2024
6 of 7 checks passed
@theEvilReaper theEvilReaper deleted the feature/testImprovements branch November 11, 2024 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants