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

Fixes #194: Update rs.utils.in_asu() docstring to clarify behavior #219

Merged
merged 1 commit into from
Aug 3, 2023

Conversation

JBGreisman
Copy link
Member

This PR addresses #194 to clarify that rs.utils.in_asu() does not accept +/- Friedel pairs -- only Miller indices in the +ASU will be labeled as True.

@JBGreisman JBGreisman added the documentation Issue related to documentation label Aug 3, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #219 (1300f70) into main (8932d5b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #219   +/-   ##
=======================================
  Coverage   92.38%   92.38%           
=======================================
  Files          37       37           
  Lines        2428     2428           
=======================================
  Hits         2243     2243           
  Misses        185      185           
Flag Coverage Δ
unittests 92.38% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
reciprocalspaceship/utils/asu.py 100.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@JBGreisman JBGreisman merged commit 5b2b793 into main Aug 3, 2023
@JBGreisman JBGreisman deleted the docstring branch August 3, 2023 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants