Rename doc files and fix typos #246
Conversation
| @@ -13,27 +13,27 @@ This example will demonstrate how to use the functions in the | |||
| to convert it to ``2theta`` or ``d``. :: | |||
|
|
|||
| # Example: convert q to 2theta | |||
| from diffpy.utils.transformers import q_to_tth | |||
| from diffpy.utils.transforms import q_to_tth | |||
|
Warning! No news item is found for this PR. If this is a user-facing change/feature/fix, |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #246 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 8 8
Lines 380 380
=========================================
Hits 380 380 |
Have you rendered the docs locally to check all links are populated and no broken links? |
Yep, I just built them locally and every link works. Here's a screenshot: |
|
The transforms example was displayed improperly. I edited it and it's working now.
|
|
Lovely, looks good to me |
|
|
||
| # Example: convert d to q | ||
| from diffpy.utils.transformers import tth_to_q | ||
| from diffpy.utils.transforms import d_to_q |
|
thanks @bobleesj ! @sbillinge ready to review now! |
This may not fix. We will have to see. It depends if that unpack can be made to be done dynamically during the doc builds or not. If it doesn't fix it is honestly OK to have it like this in the API docs which are generally "developer-facing" and not "user-facing" and I would expect a developer to be able to figure out what is going on |
closes #238
@bobleesj I can have some feedback before @sbillinge reviews it