docs: improve docstring based on group standards in diffraction_objects.py transforms.py #300
Conversation
…ts.py transforms.py
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #300 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 9 9
Lines 516 516
=========================================
Hits 516 516 |
There was a problem hiding this comment.
@sbillinge ready for review
@yucongalicechen cc' on the changes
There was a problem hiding this comment.
I ran python ../release-scripts/auto_api.py diffpy.utils ./src/diffpy/utils ./doc/source/api/ and these are automated changes:
|
|
||
| Raises | ||
| ------ | ||
| ValueError | ||
| Raised when the length of the yarray of the two DiffractionObject instances do not match. | ||
| Raised when the xarrays of two DiffractionObject instances are not equal. |
There was a problem hiding this comment.
"not equal" feels more explicit and program-like, than "unequal" or "do not match"
| """Subtract scalar value or another DiffractionObject to the yarray of | ||
| the DiffractionObject. | ||
|
|
||
| This method behaves similarly to the `__add__` method, but performs subtraction instead of addition. |
There was a problem hiding this comment.
Since sub, mul, and truediv pretty much have the same docstrings, I asked them to refer to mul while the examples are still unique.
| The ORCID id of the user/owner | ||
|
|
||
| Returns | ||
| ------- | ||
| dict: | ||
| user_info : dict |
There was a problem hiding this comment.
seems like numpy uses both (1) what's returned and (2) its type
There was a problem hiding this comment.
| @@ -97,7 +97,7 @@ def get_user_info(owner_name=None, owner_email=None, owner_orcid=None): | |||
|
|
|||
|
|
|||
| def check_and_build_global_config(skip_config_creation=False): | |||
There was a problem hiding this comment.
Just minor prettification based on the standard
|
@sbillinge (ready for review after a minor fix, pls see my review comments above) |
|
@sbillinge ready for review - all fixed @yucongalicechen ready for 3.6.0 release checklist once this is merged. |
Closes #239 - primarily focused on DiffractionObjects and Transform functions that will be used by our beta users.