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

joaozanlorensi/fixDocsTypo #836

Merged
merged 2 commits into from
Jul 19, 2021

Conversation

joaozanlorensi
Copy link
Contributor

@joaozanlorensi joaozanlorensi commented Jul 19, 2021

Description

This Pull Request aims to close issue #835. It consists of a small typo correction in the excellent documentation about the SequentialFeatureSelector.

Related issues or pull requests

Fixes #835.

Pull Request Checklist

  • Added a note about the modification or contribution to the ./docs/sources/CHANGELOG.md file (if applicable)
  • Added appropriate unit test functions in the ./mlxtend/*/tests directories (if applicable)
  • Modify documentation in the corresponding Jupyter Notebook under mlxtend/docs/sources/ (if applicable)
  • 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)
  • Checked for style issues by running flake8 ./mlxtend

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@joaozanlorensi
Copy link
Contributor Author

Kindly check the flake8 output below:

$ flake8 ./mlxtend
./mlxtend\classifier\ensemble_vote.py:291:80: E501 line too long (80 > 79 characters)
./mlxtend\classifier\stacking_classification.py:180:80: E501 line too long (82 > 79 characters)
./mlxtend\data\iris.py:36:63: W291 trailing whitespace
./mlxtend\data\iris.py:54:75: W291 trailing whitespace
./mlxtend\evaluate\accuracy.py:24:1: W293 blank line contains whitespace
./mlxtend\evaluate\accuracy.py:27:1: W293 blank line contains whitespace
./mlxtend\evaluate\accuracy.py:33:80: E501 line too long (80 > 79 characters)
./mlxtend\evaluate\accuracy.py:34:1: W293 blank line contains whitespace
./mlxtend\evaluate\accuracy.py:38:1: W293 blank line contains whitespace
./mlxtend\evaluate\lift_score.py:39:38: W605 invalid escape sequence '\i'
./mlxtend\evaluate\scoring.py:20:9: E741 ambiguous variable name 'l'
./mlxtend\evaluate\tests\test_accuracy.py:56:52: W292 no newline at end of file
./mlxtend\externals\signature_py27.py:102:9: F841 local variable 'ex' is assigned to but never used
./mlxtend\externals\signature_py27.py:173:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:12:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:49:20: F821 undefined name 'basestring'
./mlxtend\externals\six.py:50:27: F821 undefined name 'long'
./mlxtend\externals\six.py:52:17: F821 undefined name 'unicode'
./mlxtend\externals\six.py:226:1: E305 expected 2 blank lines after class or function definition, found 1
./mlxtend\externals\six.py:238:80: E501 line too long (91 > 79 characters)
./mlxtend\externals\six.py:245:80: E501 line too long (93 > 79 characters)
./mlxtend\externals\six.py:254:80: E501 line too long (91 > 79 characters)
./mlxtend\externals\six.py:265:80: E501 line too long (87 > 79 characters)
./mlxtend\externals\six.py:266:80: E501 line too long (96 > 79 characters)
./mlxtend\externals\six.py:280:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:281:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:295:80: E501 line too long (82 > 79 characters)
./mlxtend\externals\six.py:296:80: E501 line too long (82 > 79 characters)
./mlxtend\externals\six.py:297:80: E501 line too long (82 > 79 characters)
./mlxtend\externals\six.py:354:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:356:80: E501 line too long (86 > 79 characters)
./mlxtend\externals\six.py:374:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\six.py:376:80: E501 line too long (86 > 79 characters)
./mlxtend\externals\six.py:400:80: E501 line too long (83 > 79 characters)
./mlxtend\externals\six.py:424:80: E501 line too long (84 > 79 characters)
./mlxtend\externals\six.py:426:80: E501 line too long (90 > 79 characters)
./mlxtend\externals\six.py:445:80: E501 line too long (86 > 79 characters)
./mlxtend\externals\six.py:447:80: E501 line too long (92 > 79 characters)
./mlxtend\externals\six.py:463:80: E501 line too long (92 > 79 characters)
./mlxtend\externals\six.py:465:80: E501 line too long (98 > 79 characters)
./mlxtend\externals\six.py:471:80: E501 line too long (83 > 79 characters)
./mlxtend\externals\six.py:482:1: E305 expected 2 blank lines after class or function definition, found 1
./mlxtend\externals\six.py:647:16: F821 undefined name 'unicode'
./mlxtend\externals\six.py:730:37: F821 undefined name 'basestring'
./mlxtend\externals\six.py:733:32: F821 undefined name 'file'
./mlxtend\externals\six.py:734:38: F821 undefined name 'unicode'
./mlxtend\externals\six.py:744:32: F821 undefined name 'unicode'
./mlxtend\externals\six.py:750:32: F821 undefined name 'unicode'
./mlxtend\externals\six.py:758:36: F821 undefined name 'unicode'
./mlxtend\externals\six.py:762:23: F821 undefined name 'unicode'
./mlxtend\externals\six.py:763:21: F821 undefined name 'unicode'
./mlxtend\externals\six.py:858:80: E501 line too long (80 > 79 characters)
./mlxtend\externals\pyprind\generator_factory.py:23:1: E305 expected 2 blank lines after class or function definition, found 1
./mlxtend\externals\pyprind\progbar.py:75:80: E501 line too long (85 > 79 characters)
./mlxtend\externals\pyprind\progbar.py:76:48: E128 continuation line under-indented for visual indent
./mlxtend\externals\pyprind_init_.py:14:1: F401 '.progbar.ProgBar' imported but unused
./mlxtend\externals\pyprind_init_.py:15:1: F401 '.progpercent.ProgPercent' imported but unused
./mlxtend\externals\pyprind_init_.py:16:1: F401 '.generator_factory.prog_percent' imported but unused
./mlxtend\externals\pyprind_init_.py:17:1: F401 '.generator_factory.prog_bar' imported but unused
./mlxtend\feature_extraction\tests\test_base.py:9:37: E272 multiple spaces before keyword
./mlxtend\feature_selection\exhaustive_feature_selector.py:299:9: F841 local variable 'e' is assigned to but never used
./mlxtend\feature_selection\tests\test_exhaustive_feature_selector.py:7:1: F401 'sys' imported but unused
./mlxtend\feature_selection\tests\test_exhaustive_feature_selector.py:178:53: E203 whitespace before ','
./mlxtend\file_io\find_filegroups.py:80:28: W605 invalid escape sequence '%'
./mlxtend\file_io\find_filegroups.py:89:32: W605 invalid escape sequence '%'
./mlxtend\frequent_patterns\fpcommon.py:4:1: F401 'distutils.version.LooseVersion as Version' imported but unused
./mlxtend\frequent_patterns\fpcommon.py:5:1: F401 'pandas.version as pandas_version' imported but unused
./mlxtend\plotting\scatter_hist.py:6:1: F401 'pandas as pd' imported but unused
./mlxtend\plotting\scatter_hist.py:7:1: F401 'numpy as np' imported but unused
./mlxtend\plotting\scatter_hist.py:61:5: E303 too many blank lines (2)
./mlxtend\plotting\scatter_hist.py:76:47: W291 trailing whitespace
./mlxtend\plotting\tests\test_pca_corr_graph.py:59:80: E501 line too long (91 > 79 characters)
./mlxtend\utils\tests\test_testing.py:17:9: E117 over-indented
./mlxtend_base_iterative_model.py:56:13: E117 over-indented

@joaozanlorensi
Copy link
Contributor Author

Please advise me if any further tests or action on any of the other checklist items is needed.

@rasbt
Copy link
Owner

rasbt commented Jul 19, 2021

Thanks for the PR! Also, thanks for checking the flake8 output. In your case, since this was not due to new code you added, please don't worry about it. No further action required :)

@rasbt rasbt merged commit 0a3eb5d into rasbt:master Jul 19, 2021
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.

Typo in the SequentialFeatureSelector documentation
2 participants