Cleans the documentation. The docs got a bit silly. This PR attempts to clean out the fluff and add in simple worked examples.
Ideally these examples will be in notebook form, however this will take some work.
Why was it initiated? Any relevant Issues?
I really don't like my old writing. That might be my issue...
PR Checklist
[x] develop base branch selected?
[x] This PR is not directly related to an existing issue (which has no PR yet).
- [ ] All tests still pass. No code changes should be made.
- [ ] Any new features or fixed regressions are be covered via new tests.- [ ] Any new or changed features have are fully documented.- [ ] Significant changes have been added to CHANGES.md.- [ ] First time contributors have added your name to CONTRIBUTORS.md.
What does this PR do?
Cleans the documentation. The docs got a bit silly. This PR attempts to clean out the fluff and add in simple worked examples.
Ideally these examples will be in notebook form, however this will take some work.
Why was it initiated? Any relevant Issues?
I really don't like my old writing. That might be my issue...
PR Checklist
developbase branch selected?- [ ] All tests still pass.No code changes should be made.- [ ] Any new features or fixed regressions are be covered via new tests.- [ ] Any new or changed features have are fully documented.- [ ] Significant changes have been added toCHANGES.md.- [ ] First time contributors have added your name toCONTRIBUTORS.md.