Skip to content

Updated Docs with Implementing your Own Test - #117

Merged
trevismd merged 6 commits into
trevismd:devfrom
tathey1:master
Jun 9, 2023
Merged

Updated Docs with Implementing your Own Test#117
trevismd merged 6 commits into
trevismd:devfrom
tathey1:master

Conversation

@tathey1

@tathey1 tathey1 commented Mar 16, 2023

Copy link
Copy Markdown
Contributor

In light of issue 115:

  • I added a cell in example.ipynb with "Use a custom test with StatTest," which is involves using custom code for a test (though it mostly relies on a scipy.stats function)
  • I added a README in the stats submodule, and included it in the sphinx docs with a general overview of how to do it.

@trevismd trevismd left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the PR, it looks great!
I left a few suggestions if you'd like to have a look at them, otherwise they are memo for me afterwards when this is merged. I see that you understand sphinx/rst structure better than I do. (If you'd like to help users by further improving the autogenerated documentation, I'm sure it would be much appreciated.)

For the notebook, I think we could highlight the difference with the previous cell with a small comment above the function definition, explaining that we could virtually use anything.
I have another example in another PR where I show how to support 1-sample tests, maybe I'll add this example too later on, just for demonstration.

Thanks again, and let me know if I can be of any help of course!

Comment thread docs/source/custom-test.rst Outdated
Comment thread statannotations/stats/README.rst Outdated
Comment thread statannotations/stats/README.rst Outdated
tathey1 and others added 5 commits March 23, 2023 16:15
Co-authored-by: Florian Charlier <477844+trevismd@users.noreply.github.com>
Co-authored-by: Florian Charlier <477844+trevismd@users.noreply.github.com>
Co-authored-by: Florian Charlier <477844+trevismd@users.noreply.github.com>
@tathey1

tathey1 commented Mar 23, 2023

Copy link
Copy Markdown
Contributor Author

@trevismd I agree with all your suggestions. I addressed them all, I think.

@trevismd
trevismd changed the base branch from master to dev March 30, 2023 19:31
@codecov

codecov Bot commented Mar 30, 2023

Copy link
Copy Markdown

Codecov Report

Merging #117 (77d5033) into dev (2a5ebe1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #117   +/-   ##
=======================================
  Coverage   97.04%   97.04%           
=======================================
  Files          29       29           
  Lines        1898     1898           
=======================================
  Hits         1842     1842           
  Misses         56       56           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@trevismd
trevismd merged commit c05cbf2 into trevismd:dev Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants