Skip to content

Conversation

@SteveMcGrath
Copy link
Contributor

Description

Adjusts docstring to address documentation example issue as represented in #960

Type of change

Please delete options that are not relevant.

  • 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)
  • This change requires a documentation update

How Has This Been Tested?

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@SteveMcGrath SteveMcGrath requested a review from a team as a code owner November 4, 2025 19:20
@SteveMcGrath SteveMcGrath merged commit 1c0297a into main Nov 17, 2025
8 of 9 checks passed
@SteveMcGrath SteveMcGrath deleted the fix/fix-scan-exmaple branch November 17, 2025 19: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.

3 participants