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

MAINT: Add slim to summary docstring #8004

Merged
merged 1 commit into from Jan 10, 2022
Merged

Conversation

bashtage
Copy link
Member

Add optional parameter slim to docstring of summary

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.

Add optional parameter slim to docstring of summary
@bashtage bashtage merged commit 66ecf2e into statsmodels:main Jan 10, 2022
@bashtage bashtage deleted the doc-slim branch January 10, 2022 13:47
bashtage added a commit to bashtage/statsmodels that referenced this pull request Jan 10, 2022
MAINT: Add slim to summary docstring
bashtage added a commit to bashtage/statsmodels that referenced this pull request Feb 1, 2022
MAINT: Add slim to summary docstring
(cherry picked from commit 66ecf2e)

# Conflicts:
#	statsmodels/regression/tests/test_regression.py
@bashtage
Copy link
Member Author

bashtage commented Feb 1, 2022

💚 All backports created successfully

Status Branch Result
maintenance/0.13.x

Questions ?

Please refer to the Backport tool documentation

bashtage added a commit that referenced this pull request Feb 1, 2022
…-8004

[maintenance/0.13.x] Merge pull request #8004 from bashtage/doc-slim
@josef-pkt josef-pkt added this to the 0.13.2 milestone Feb 20, 2023
@bashtage bashtage modified the milestones: 0.13.2, 0.14 Apr 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: slim parameter description not documented in OLS.summary()
2 participants