Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update pvalue description in weightstats.py of ztest and ztest_mean #9226

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

luke396
Copy link
Contributor

@luke396 luke396 commented Apr 21, 2024

The pvalue description in the weightstats.py file has been updated from "pvalue of the t-test" to "pvalue of the z-test". This change ensures accurate documentation of the statistical test being performed.

Notes:

  • It is essential that you add a test when making code changes. Tests are not
    needed for doc changes.
  • When adding a new function, test values should usually be verified in another package (e.g., R/SAS/Stata).
  • When fixing a bug, you must add a test that would produce the bug in main and
    then show that it is fixed with the new code.
  • New code additions must be well formatted. Changes should pass flake8. If on Linux or OSX, you can
    verify you changes are well formatted by running
    git diff upstream/main -u -- "*.py" | flake8 --diff --isolated
    
    assuming flake8 is installed. This command is also available on Windows
    using the Windows System for Linux once flake8 is installed in the
    local Linux environment. While passing this test is not required, it is good practice and it help
    improve code quality in statsmodels.
  • Docstring additions must render correctly, including escapes and LaTeX.

The pvalue description in the `weightstats.py` file has been updated from "pvalue of the t-test" to "pvalue of the z-test". This change ensures accurate documentation of the statistical test being performed.
@luke396 luke396 changed the title feat: Update pvalue description in weightstats.py of ztest DOC: Update pvalue description in weightstats.py of ztest and ztest_mean Apr 21, 2024
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.

DOC: ztest documentation says that it returns pvalue of the t-test .
1 participant