rasbt / mlxtend

A library of extension and helper modules for Python's data analysis and machine learning libraries.

https://rasbt.github.io/mlxtend/

Other

4.82k stars 853 forks source link

Fixing multiple documentation issues #995

Closed zuari1993 closed 1 year ago

zuari1993 commented 1 year ago

Description

Fixes #849 - Removed the incorrect statement: ~~note that 'support' depends on 'antecedent support' and 'consequent support' via min('antecedent support', 'consequent support')~~ since this is false.

Fixes #951 - Added references.

Pull Request Checklist

[X] Added a note about the modification or contribution to the ./docs/sources/CHANGELOG.md file (if applicable)
[X] Added appropriate unit test functions in the ./mlxtend/*/tests directories (if applicable)
[X] Modify documentation in the corresponding Jupyter Notebook under mlxtend/docs/sources/ (if applicable)
[X] Ran PYTHONPATH='.' pytest ./mlxtend -sv and make sure that all unit tests pass (for small modifications, it might be sufficient to only run the specific test file, e.g., PYTHONPATH='.' pytest ./mlxtend/classifier/tests/test_stacking_cv_classifier.py -sv)
[X] Checked for style issues by running flake8 ./mlxtend

review-notebook-app[bot] commented 1 year ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov[bot] commented 1 year ago

Codecov Report

Base: 77.45% // Head: 77.45% // No change to project coverage :thumbsup:

Coverage data is based on head (fde8235) compared to base (75c5284). Patch has no changes to coverable lines.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #995 +/- ## ======================================= Coverage 77.45% 77.45% ======================================= Files 198 198 Lines 11171 11171 Branches 1406 1406 ======================================= Hits 8652 8652 Misses 2305 2305 Partials 214 214 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Sebastian+Raschka). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Sebastian+Raschka)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

zuari1993 commented 1 year ago

Hi @rasbt , Please let me know if you any problem here that prevents you from making the merge.

rasbt commented 1 year ago

Thanks for the PR!

I see that the header mentioned issues, but when I checked the changes, I could only find those two (removing one note, and adding one reference)

am I missing some?

zuari1993 commented 1 year ago

Thanks for your reply. I will check and get back to you on this.