docs: for functions module #163
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #163 +/- ##
=======================================
Coverage 99.21% 99.21%
=======================================
Files 5 5
Lines 254 254
=======================================
Hits 252 252
Misses 2 2 |
| plt.title("Original vs. Corrected Intensity") | ||
| plt.show() | ||
|
|
||
| 4. You can modify the global parameters |
There was a problem hiding this comment.
For this section, I'm wondering if I should add these parameters in the brute force computation function, e.g.,
compute_cve(input_pattern, mud, method="polynomial_interpolation", xtype="tth", n_points_on_diameter=None, tth_grid=None)
so that people can edit these without modifying the global parameters. This is probably uncommon so we don't need to modify anything in the main app.
There was a problem hiding this comment.
This would make this more general and so better. However, for things like this we may want to wait until someone asks for it and then do it? Maybe put it as a feature request in the issues so we don't forget? We could create a milestone which is a holding place for feature requests, and we can move them to a release milestone when someone requiests it and we decide we want to do it?
There was a problem hiding this comment.
Sounds great, I'll do that!
There was a problem hiding this comment.
It seems that I can't add a new milestone.. but I created an issue for this
There was a problem hiding this comment.
please see comment. I will merge this because documentation is easier to review when it is built, but @yucongalicechen please read and act on the comment.
| plt.title("Original vs. Corrected Intensity") | ||
| plt.show() | ||
|
|
||
| 4. You can modify the global parameters |
There was a problem hiding this comment.
This would make this more general and so better. However, for things like this we may want to wait until someone asks for it and then do it? Maybe put it as a feature request in the issues so we don't forget? We could create a milestone which is a holding place for feature requests, and we can move them to a release milestone when someone requiests it and we decide we want to do it?
closes #157
@sbillinge ready for review