search

dkriegner / xrayutilities

xrayutilities - a package with useful scripts for X-ray diffraction physicists
http://xrayutilities.sourceforge.io
GNU General Public License v2.0
83 stars 29 forks source link

Confusion in documentation #190

Closed brussel13 closed 4 months ago

brussel13 commented 4 months ago

I made a mistake interpreting the Experiment class documentation. I interpreted "into the primary beam direction" as meaning upstream.
Something like "Look into the light", or "Look into the beam" meaning to look at the source. Maybe change this to "downstream" or "parallel to"?

Parameters : ipdirlist or tuple or array-like inplane reference direction (ipdir points into the primary beam direction at zero angles)

dkriegner commented 4 months ago

Thanks for reporting this. I will look into it. Certainly some more eyes critically looking into these formulations could be beneficial.

dkriegner commented 4 months ago

@brussel13 Could you please check the changes in #192? Do they fully address the issue?

brussel13 commented 4 months ago

Yes, this is very clear now. I would not have made the same mistake with this documentation. Thanks

From: Dominik Kriegner @.> Sent: Monday, July 29, 2024 7:27 AM To: dkriegner/xrayutilities @.> Cc: Harder, Ross J. @.>; Mention @.> Subject: Re: [dkriegner/xrayutilities] Confusion in documentation (Issue #190)

@brussel13 Could you please check the changes in #192? Do they fully address the issue? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned. Message ID: dkriegner/xrayutilities/issues/190/2255798131@ github. com ZjQcmQRYFpfptBannerStart This Message Is From an External Sender This message came from outside your organization.

ZjQcmQRYFpfptBannerEnd

@brussel13https://urldefense.us/v3/__https://github.com/brussel13__;!!G_uCfscf7eWS!fOoesq-pUsUg43m3-vrqumukILy9l5oZ8rqrYFkDtNB3FP-gFmO5bzWNapzsWo3pChN6_WpmSl0kzEkqWRIa__TbXg$ Could you please check the changes in #192https://urldefense.us/v3/__https://github.com/dkriegner/xrayutilities/pull/192__;!!G_uCfscf7eWS!fOoesq-pUsUg43m3-vrqumukILy9l5oZ8rqrYFkDtNB3FP-gFmO5bzWNapzsWo3pChN6_WpmSl0kzEkqWRLpwnKd2Q$? Do they fully address the issue?

— Reply to this email directly, view it on GitHubhttps://urldefense.us/v3/__https://github.com/dkriegner/xrayutilities/issues/190*issuecomment-2255798131__;Iw!!G_uCfscf7eWS!fOoesq-pUsUg43m3-vrqumukILy9l5oZ8rqrYFkDtNB3FP-gFmO5bzWNapzsWo3pChN6_WpmSl0kzEkqWRINDoMrLA$, or unsubscribehttps://urldefense.us/v3/__https://github.com/notifications/unsubscribe-auth/ABZ6SOESKCK5HX4XIVORMHTZOYYMJAVCNFSM6AAAAABLS7JVKKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJVG44TQMJTGE__;!!G_uCfscf7eWS!fOoesq-pUsUg43m3-vrqumukILy9l5oZ8rqrYFkDtNB3FP-gFmO5bzWNapzsWo3pChN6_WpmSl0kzEkqWRKrG8X9Ew$. You are receiving this because you were mentioned.Message ID: @.***>