docs: add docstrings for on_d, on_q, on_tth, and dump #307
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #307 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 9 9
Lines 516 516
=========================================
Hits 516 516 |
There was a problem hiding this comment.
brilliatn @yucongalicechen . Please see a couple of small edits.
|
|
||
| Returns | ||
| ------- | ||
| (xarray, yarray) : tuple of ndarray |
There was a problem hiding this comment.
let's change xarray to q-array to be explicit. And also below, xarray-> tth-array and so on. Just to make it really clear.
|
|
||
| Parameters | ||
| ---------- | ||
| filepath : str |
There was a problem hiding this comment.
non programmers may not know that that the path includes the filename. Best here is to give an example.
There was a problem hiding this comment.
@sbillinge added in the new commit. please review
| To save a diffraction object to a file named "diffraction_data.chi" with | ||
| the independent variable 'q': | ||
|
|
||
| >>> file = "diffraction_data.chi" |
There was a problem hiding this comment.
Let's also have another example, that shows a relative path. I think that should then be clear enough.
There was a problem hiding this comment.
Sounds great! I'll add that.
closes #306
@sbillinge ready for review