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 functional test documentation #529

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Conversation

AaronFeickert
Copy link
Contributor

Description

Updates the functional test documentation to fix issues and improve readability.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor
  • New or updated tests
  • Dependency Update

Notes to Reviewers

These directions were tested on a macOS 15.1.1 installation.

Checklist

  • I have performed a self-review of my code.
  • I have commented my code where necessary.
  • I have updated the documentation if needed.
  • My changes do not introduce new warnings.
  • I have added tests that prove my changes are effective or that my feature works.
  • New and existing tests pass with my changes.

Related Issues

None.

@AaronFeickert AaronFeickert requested a review from a team as a code owner December 9, 2024 18:13
delbonis
delbonis previously approved these changes Dec 9, 2024
Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.43%. Comparing base (b5f84a0) to head (bc73b2f).
Report is 2 commits behind head on main.

@@            Coverage Diff             @@
##             main     #529      +/-   ##
==========================================
- Coverage   58.55%   58.43%   -0.13%     
==========================================
  Files         277      277              
  Lines       29341    29341              
==========================================
- Hits        17182    17145      -37     
- Misses      12159    12196      +37     

see 5 files with indirect coverage changes

Copy link
Member

@storopoli storopoli left a comment

Choose a reason for hiding this comment

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

Minor formatting nits and one clarification on --no-root.

Copy link
Member

@storopoli storopoli left a comment

Choose a reason for hiding this comment

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

ACK bc73b2f

@storopoli storopoli merged commit 5948b42 into main Dec 9, 2024
17 of 18 checks passed
@storopoli storopoli deleted the functional-test-docs branch December 9, 2024 20:15
voidash pushed a commit that referenced this pull request Dec 12, 2024
* Update functional test documentation

* Review fixes
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.

3 participants