Skip to content

Rename id to uuid in DiffractionObject #271

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

Merged
sbillinge merged 8 commits into from
Dec 26, 2024
Merged

Rename id to uuid in DiffractionObject #271

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1a2214f
Rename id to uuid in DiffractionObjet
bobleesj Dec 23, 2024
209a194
Add separate docstring for @property methods
bobleesj Dec 26, 2024
5824250
Improve docstring for all_arrays
bobleesj Dec 26, 2024
2f293c0
Remove extra singl quote around comment
bobleesj Dec 26, 2024
ceba7f9
Fix docstring for all_arrays per sbilling pr review
bobleesj Dec 26, 2024
2d1c104
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Dec 26, 2024
b198d66
Remove extra mention of yarray
bobleesj Dec 26, 2024
98a3028
Merge branch '_uuid' of https://github.com/bobleesj/diffpy.utils into…
bobleesj Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Improve docstring for all_arrays
  • Loading branch information
@bobleesj
bobleesj committed Dec 26, 2024
commit 5824250c02fca1e067598615b48418eb24a48504
4 changes: 2 additions & 2 deletions src/diffpy/utils/diffraction_objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,12 @@ def __rtruediv__(self, other):

@property
def all_arrays(self):
"""The array containing `xarray` values in q, d, tth, and `yarray`.
"""The 2D array containing `xarray` and `yarray` values.

Returns
-------
ndarray
The 2D matrix containing the `xarray` objects values and `yarray`.
The 2D array containing the `xarray` values in q, tth, d, and `yarray`.
Copy link
Copy Markdown
Contributor

@sbillinge sbillinge Dec 26, 2024

Choose a reason for hiding this comment

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

for lower cognitive load I would change to The shape(len(data), 4)2D array with columns containing theyarray(intensity) and thexarray values in q, tth, and d . so they appear in the docstring in the same order as in the array columns

Copy link
Copy Markdown
Contributor Author

@bobleesj bobleesj Dec 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, great! superb. The example and this docstring makes it super clear.


Examples
--------
Expand Down