Added sphinx documentation for data shifts routine. #131
Conversation
kperrynrel
changed the title
There was a problem hiding this comment.
The docs build is going to fail here until #124 is merged, so I think we should wait on doing a real review until then, but I built it locally and it looks pretty good! Here are some comments in the meantime.
Co-authored-by: Kevin Anderson <57452607+kanderso-nrel@users.noreply.github.com>
|
@kperrynrel I think the docs build failure will be resolved by adding a new item Lines 13 to 15 in e8ce801 |
|
@kanderso-nrel thanks for the tip on the readthedocs.yml--that would've taken me hours to debug!! |
|
@kanderso-nrel I'd say things are looking good for review at this point! Let me know what you think. |
There was a problem hiding this comment.
Thanks @kperrynrel, here are some suggestions. FYI there are a couple comments earlier in the thread that are still relevant today.
Description
Thank you for your contribution! Please provide a brief description of the problem and the proposed solution or new feature (if not already fully described in a linked issue)
Checklist
This PR is dependent on PR #124. It contains the Sphinx documentation for the data shift algorithm.
The following items must be addressed before the code can be merged.
Please don't hesitate to ask for help if you are unsure of how to accomplish any of the items.
You are free to remove any checklist items that do not apply or add additional items that are
not on this list
in
docs/whatsnewfor all changes. Includes link to the GitHub Issue with
:issue:`num`or this Pull Request with
:pull:`num`. Includes contributor nameand/or GitHub username (link with
:ghuser:`user`).