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

Resolving doctest errors - correcting test classifications. #856

Merged
merged 1 commit into from Jul 16, 2022

Conversation

timmiesmith
Copy link
Contributor

Description

The doctest script run to analyze the Doxygen comments in test files indicated the classification of the tests introduced in #846 was incorrect, and some tests were missing required comments. This PR resolves those issues.

  • - git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details)

Type of change

Choose one or multiple, leave empty if none of the other choices apply

Add a respective label(s) to PR if you have permissions

  • bug fix - change that fixes an issue
  • new feature - change that adds functionality
  • tests - change in tests
  • infrastructure - change in infrastructure and CI
  • documentation - documentation update

Tests

  • added - required for new features and some bug fixes
  • not needed

Documentation

  • updated in # - add PR number
  • needs to be updated
  • not needed

Breaks backward compatibility

  • Yes
  • No
  • Unknown

Notify the following users

@AnuyaWelling2801

Other information

@timmiesmith timmiesmith merged commit 3232606 into master Jul 16, 2022
@timmiesmith timmiesmith deleted the timmiesm/test-doc-fix branch July 16, 2022 00:26
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

2 participants