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.

Sign up for GitHub

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

Jump to bottom

update DetectorParams docstring #193

Merged
merged 1 commit into from
Sep 10, 2024
Merged

update DetectorParams docstring #193

merged 1 commit into from
Sep 10, 2024

Conversation

semaphoreP
Copy link
Contributor

@semaphoreP semaphoreP commented Sep 9, 2024 •
edited
Loading

Describe your changes

Flesh out DetectorParams docstring with intended usage

Type of change

Please delete options that are not relevant (and this line).

  • New feature (non-breaking change which adds functionality)

Reference any relevant issues (don't forget the #)

Closes #118

Checklist before requesting a review

  • I have linted my code
  • I have verified that all unit tests pass in a clean environment and added new unit tests, as needed
  • I have verified that all docstrings are properly formatted and added new documentation, as needed

@maxwellmb maxwellmb merged commit 448ce91 into main Sep 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxwellmb maxwellmb maxwellmb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The Docstring for the DetectorParams datatype should be more fleshed out
2 participants
@semaphoreP @maxwellmb