[DOC] various doc changes incl contributing #353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zbarry
changed the title
Codecov Report
@@ Coverage Diff @@
## dev #353 +/- ##
=======================================
Coverage 87.87% 87.87%
=======================================
Files 10 10
Lines 726 726
=======================================
Hits 638 638
Misses 88 88 |
ericmjl
requested changes
May 12, 2019
Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>
ericmjl
approved these changes
May 12, 2019
hectormz
pushed a commit
to hectormz/pyjanitor
that referenced
this pull request
May 13, 2019
* various doc changes * Update LICENSE Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>
dendrondal
pushed a commit
to dendrondal/pyjanitor
that referenced
this pull request
May 18, 2019
* various doc changes * Update LICENSE Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>
ericmjl
pushed a commit
that referenced
this pull request
May 19, 2019
* Removed all document strings > 80 chars, split coalesce test into multiple * added method rd_molecular_descriptors to chemistry.py * added maccs_keys_fingerprint method to chemistry.py * add jupyterlab as a development dependency * fix wsl support - rdkit/libxrender issue * xfail finance test and applied black * update docstring for currency API request * Renamed rd_molecular_descriptors to molecular_descriptors * Added test cases for maccs_keys_fingerprint Chemistry function * Added test for molecular_descriptors * Fixed style errors * Moved test_chemistry.py into tests/chemistry folder * Refactored test_chemistry into two files, one for each function test_chemistry had tests for * Added flake8 disable unused-import comments. Import is used to add smiles2mol functionality, but flake8 does not recognize this use. * added myself to Authors.rst file * Fixed pycodestyle errors * case_when * update_where * update_where * update_where * update_where * update_where * Update janitor/functions.py Co-Authored-By: jcvall <jcvall@icloud.com> * fixed example * switch pip editable mode to setup develop mode * code style changes * Set up CI with Azure Pipelines [skip ci] * Add install for pyjanitor So... to actually test the package, we *actually* need to have it installed :). * Add test for correct installation. * Add testing of testing_utils import * Install package in editable mode for testing * Used development mode for package install * Add hypothesis and requests to testing tooling. * Switched to conda installation. * activated pyjanitor environment before running tests * move pipeline master and remove miniconda * refactoring to multiple operating systems * refactoring on linux first * properly indented job * add macOS and windows to pipeline spec * Add brief summary to docs * Tagging @szuckerman and @zbarry as project leads. * Update docs/index.rst Co-Authored-By: jekwatt <jekwatt@users.noreply.github.com> * Add jekwatt to AUTHORS.rst * Fix pandas intersphinx doc references * added documentation in contributing.rst about test failing locally * Added section to 'Getting Started' for PyCharm users * added my self to the Author.rst file * Add to_datetime wrapper and include test * Fix naming conventions in expand_column() * change type exception handling * Switch to using kwargs * Add skipif for tests you don't want locally * Update CONTRIBUTING.rst Co-Authored-By: SorenFrohlich <SorenFrohlich89@hotmail.com> * Update CONTRIBUTING.rst Co-Authored-By: SorenFrohlich <SorenFrohlich89@hotmail.com> * README.rst * Update add_column.md * Create README.rst This summarizes what is contained in the examples folder * Update README.rst * Add support for example jupyter notebooks in doc * Update README.rst * Rename README.rst to README.md * added author dave-frazzetto * Remove some obsolete text * Deleting old example usage doc * change type -- unit tests * fix case * Add ability to groupby and agg, but chain it within the same dataframe * Updating example notebook after merge conflict * fix case * Add jupyter file for TidyTuesday 2019-04-30 R code obtained from https://github.com/rfordatascience/tidytuesday/tree/47567cb80846739c8543d158c1f3ff226c7e5a5f/data/2019/2019-04-30 This code was translated to Python. * update api part * update api part * update api part * update api part * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * function description * uncomment import * Remove functional example * fix function description * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * update api part * update api part * update api part * Include suggested text from @ericmjl * add example notebook * fix the docstring for the column_order that is defined to opt for which duplicated column idx to be removed * added board_game data demo notebook * added a test to check index after remove_empty ; added a reset_index in remove_empty to fix the test * PR189: changed implementation of remove_columns from del df[...] to df.drop(...). Added test cases * Add nbsphinx to requirements #220 * Cleanup code formatting issues raised by black and pycodestyle * moved notebooks into notebooks/ dir * add code style checks to tests * Added default argument and type hinting to coalesce, updated relevant documentation. * Add kernel installation * add nbconvert * fixed board_games notebook * Added test for case in which new_column_name is not given * fixed notebook execution * Fix naming conventions in get_dupes() and encode_categorical() * fix example + black * black formatting applied * added binder link * Fixed comments from PR * Update janitor/functions.py Co-Authored-By: dave-frazzetto <david.frazzetto@gmail.com> * improve docstrings for some of the more advanced functions in functions.py. I made sure that the code is executable * Update the dirty_data workbook Change so the relevant data is displayed after the remove row step. * reformat black * changed docstrings to under 79 chars per line * Add PHONY section to root makefile * add a new functionality for droping a duplicated column * Link to Pandas Categorical in encode_categorical docstring. It was not obvious that the function converts to the Pandas category dtype or what the Pandas category dtype was. * standardized nbs * added nb guidelines * added self to authors.rst * fixed isort * fix the linting * reset the except * fixed makefile and ensured pycodestyle * Update naming conventions in label_encode, convert_excel_date, covert_matlab_date, convert_unix_date * Added bin_numeric function with tests. * Improved DAG documentation * Adding data_dictionary accessor for high-level stats * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * first commit to io module with read_csvs * adding test for read_csvs, work in progress * update after the review * ensured pycodestyle compliance * fixed nb * updated boardgame nb * Adding the beautiful new logo to documentation * Fixed code style and format * Replaced inplace everywhere appropriately * Added Deprecation Warning for the reset_index_inplace method * Add example notebook tidytuesday_2019-04-23 * added a utils.py file in tests which contains a function which checks if a another function is idempotent. ALso added tests to check that the fucking ehaves as expected * Used black * spreadout the list comprehension for readibility * Rename to data_description * Formatting conf.py from docs * Small change to remove flake8 statement * Remove image from readme (doesn't render on github) * fixed format issues. Due to minor git mistakes, this push also includes docstring changes to certain function in janitor/functions.py such that the code in the docstring is executable * Cleaned up format to look cleaner in docs * added references * removed test/utils.py and placed the function within it into janitor/utils.py * minor changes to janitor/utils.y * test new doc architecture * Add test skip for checking Unix time on Windows * new index * Fixed length issue for pycodestyle * made sure there was 1 and only 1 extra line at the end of utils.py * Making Black happy! * Update janitor/functions.py Co-Authored-By: catherinedevlin <catherine.devlin@gmail.com> * add summary for functions, subheadings proposed by jk3587 * Added Deprecation message + ran black * adding function read_csvs to janitor.io * Add in multi-index groupby_agg and accompanying unit tests * create notebook example of replacing bad values with np.NaN * new doc architecture * Update the documentation. In the documentation table of contents rename Example notebooks to Examples. Remove the contributing info from the notebook pyjanitor_intro.ipynb. Remove the bold from pyjanitor in the top level title. Doing this to avoid bold in the documentation table of contents. Change so it is just one "top-level" title in the notebooks pyjanitor_intro and tidytuesday_20190423.ipynb. Change the order of the table of contents so the pyjaitor_intro notebook always is the first example. Add Installation in the table of contents. Change so the examples come before the API Documentation in the table of contents. * Make Black happy * fixed docstring for encode_categorical method * working demo of new doc architecture * Split out development dependencies into requirements-dev.txt Non-development users do not need to run tests, format code, build docs, so omitting those from requirements.txt reduces the package's size for them. * Added TOC header * Clearer unit test for multi-groupby * reformat with black * io.read_csvs restricts input to csvs with same columns * io.read_csvs: removed csv extension requirement * black formmatin to io.read_csvs * Get isort from conda-forge Without specifying a source, conda installation of isort fails * added tables describing bio, chem, finance, etc levels of pyjanitor * removed obsolete test csv files * fixed style issues * Add decorator to cleanly alias deprecated arguments * Update pull request template There should be (hopefully) more helpful hints in here. * Update README with pithy description of pyjanitor * Update CONTRIBUTING.rst Emphasized docs contributions first, and added rationales for a bunch of things. * Add bin_numeric to general functions Resolves #303. * Create ISSUE_TEMPLATE.md * Update pull_request_template.md Added some more contextual information requested. * Update pull_request_template.md * Create bug report template. * Delete ISSUE_TEMPLATE.md * Create documentation_fix.md * Create new_proposed_feature.md * Apply new alias decorator to previously updated functions with deprecated argument names * Create new_examples.md * Removed all document strings > 80 chars, split coalesce test into multiple * Update naming conventions in rename_column(), get_features_targets() * Update naming conventions in coalesce() and fill_empty() * Update naming conventions in concatenate_columns() and deconcatenate_column() * Update naming conventions in filter_string() and filter_column_isin() * Update naming conventions in change_type() and add_column() * Update naming conventions in min_max_scale() and remove_columns() * Update naming conventions for round_to_fraction(), transform_column(), transform_columns() * Update naming conventions for currency_column_to_numeric() and select_columns() * column_added * noindex on functions page to get rid of build errors * convert notebook readme to RST * comment out round_to_fraction example #329 * comment out example in row_to_names * add autosummary_generate to get rid of build errors * autogenerate janitor functions * pydocstyle fixes * applied black * fixed function docstrings using pydocstyle * finance header is now correct * merge conflict resolution * apply black and pycodestyle fixes * remove functions.rst * fix pydocstyle * fix linting issues * more docfixes * pycodestyle fix * black * re-run checks * fixed misnamed black command * [DOC] Normalization notebook (WIP) (#320) * Adding @jcvall's notebook of normalization examples Fleshed it out with explanatory text. Closes #135 * Cleared notebook output https://nbsphinx.readthedocs.io/en/latest/usage.html suggests clearing output * [DOC] Use readthedocs YAML v2 for building docs (#334) * [DOC] Update infrastructure for readthedocs (#335) * add readthedocs config * readthedocs fixes * add ipykernel to requirements-dev.txt * add seaborn to requirements-dev * [DOC] Remove example.py in examples directory (#337) * [TST] add skipif for biology (#338) * Update missing docstring parameters (#340) * Rename descriptors to descriptors_mapping in chemistry.py (#341) This helps silence mypy's complaints on `chemistry.py`. * [TST] Add codecov to build pipeline (#343) * re-enabled coverage * add uploading of coverage reports to test pipeline * add pytest-azurepipelines to dev requirements * add pytest-azurepipelines to environment-dev.yml * move pytest-azurepipelines to conda * move python-language-server to conda * move sphinxcontrib-fulltoc to conda * add token for codecov * Update Azure build badge (#350) Update Azure build status badge in README.rst * [ENH] Mega-refactoring (#349) * refactoring, changing type annotations * added deprecation. removed annotations for non list names * fixed docstring length issues * [ENH] move utility functions to utils.py (#356) * [ENH] Datadesc repr (#352) * add a repr to DataDesc * remove todo, fix docstring, move away from assertionerror * [DOC] various doc changes incl contributing (#353) * various doc changes * Update LICENSE Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com> * Update naming conventions for filter_date() (#358) * Fix tidytuesday_20190423 (#359) * [ENH] Add take_first function (#363) * Add take_first function * Add test for take_first * [DOC] Update general_functions with missing functions (#364) * Update general_functions with missing functions * add functions to docs * fix tests * separate out tests from code coverage * tests pass * Trying hotfix merge * Revert "Trying hotfix merge" This reverts commit 119ac398 * Pre-merge commit with current version * Condensed all documentation down to 80 char lines (except for links), added whitespace in line 459 that was causing azure build to fail.
ericmjl
pushed a commit
that referenced
this pull request
May 29, 2019
…s. (#385) * add jupyterlab as a development dependency * fix wsl support - rdkit/libxrender issue * xfail finance test and applied black * update docstring for currency API request * Renamed rd_molecular_descriptors to molecular_descriptors * Added test cases for maccs_keys_fingerprint Chemistry function * Added test for molecular_descriptors * Fixed style errors * Moved test_chemistry.py into tests/chemistry folder * Refactored test_chemistry into two files, one for each function test_chemistry had tests for * Added flake8 disable unused-import comments. Import is used to add smiles2mol functionality, but flake8 does not recognize this use. * added myself to Authors.rst file * Fixed pycodestyle errors * case_when * update_where * update_where * update_where * update_where * update_where * Update janitor/functions.py Co-Authored-By: jcvall <jcvall@icloud.com> * fixed example * switch pip editable mode to setup develop mode * code style changes * Set up CI with Azure Pipelines [skip ci] * Add install for pyjanitor So... to actually test the package, we *actually* need to have it installed :). * Add test for correct installation. * Add testing of testing_utils import * Install package in editable mode for testing * Used development mode for package install * Add hypothesis and requests to testing tooling. * Switched to conda installation. * activated pyjanitor environment before running tests * move pipeline master and remove miniconda * refactoring to multiple operating systems * refactoring on linux first * properly indented job * add macOS and windows to pipeline spec * Add brief summary to docs * Tagging @szuckerman and @zbarry as project leads. * Update docs/index.rst Co-Authored-By: jekwatt <jekwatt@users.noreply.github.com> * Add jekwatt to AUTHORS.rst * Fix pandas intersphinx doc references * added documentation in contributing.rst about test failing locally * Added section to 'Getting Started' for PyCharm users * added my self to the Author.rst file * Add to_datetime wrapper and include test * Fix naming conventions in expand_column() * change type exception handling * Switch to using kwargs * Add skipif for tests you don't want locally * Update CONTRIBUTING.rst Co-Authored-By: SorenFrohlich <SorenFrohlich89@hotmail.com> * Update CONTRIBUTING.rst Co-Authored-By: SorenFrohlich <SorenFrohlich89@hotmail.com> * README.rst * Update add_column.md * Create README.rst This summarizes what is contained in the examples folder * Update README.rst * Add support for example jupyter notebooks in doc * Update README.rst * Rename README.rst to README.md * added author dave-frazzetto * Remove some obsolete text * Deleting old example usage doc * change type -- unit tests * fix case * Add ability to groupby and agg, but chain it within the same dataframe * Updating example notebook after merge conflict * fix case * Add jupyter file for TidyTuesday 2019-04-30 R code obtained from https://github.com/rfordatascience/tidytuesday/tree/47567cb80846739c8543d158c1f3ff226c7e5a5f/data/2019/2019-04-30 This code was translated to Python. * update api part * update api part * update api part * update api part * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * function description * uncomment import * Remove functional example * fix function description * Update janitor/functions.py Co-Authored-By: mdini <medini.maha@gmail.com> * update api part * update api part * update api part * Include suggested text from @ericmjl * add example notebook * fix the docstring for the column_order that is defined to opt for which duplicated column idx to be removed * added board_game data demo notebook * added a test to check index after remove_empty ; added a reset_index in remove_empty to fix the test * PR189: changed implementation of remove_columns from del df[...] to df.drop(...). Added test cases * Add nbsphinx to requirements #220 * Cleanup code formatting issues raised by black and pycodestyle * moved notebooks into notebooks/ dir * add code style checks to tests * Added default argument and type hinting to coalesce, updated relevant documentation. * Add kernel installation * add nbconvert * fixed board_games notebook * Added test for case in which new_column_name is not given * fixed notebook execution * Fix naming conventions in get_dupes() and encode_categorical() * fix example + black * black formatting applied * added binder link * Fixed comments from PR * Update janitor/functions.py Co-Authored-By: dave-frazzetto <david.frazzetto@gmail.com> * improve docstrings for some of the more advanced functions in functions.py. I made sure that the code is executable * Update the dirty_data workbook Change so the relevant data is displayed after the remove row step. * reformat black * changed docstrings to under 79 chars per line * Add PHONY section to root makefile * add a new functionality for droping a duplicated column * Link to Pandas Categorical in encode_categorical docstring. It was not obvious that the function converts to the Pandas category dtype or what the Pandas category dtype was. * standardized nbs * added nb guidelines * added self to authors.rst * fixed isort * fix the linting * reset the except * fixed makefile and ensured pycodestyle * Update naming conventions in label_encode, convert_excel_date, covert_matlab_date, convert_unix_date * Added bin_numeric function with tests. * Improved DAG documentation * Adding data_dictionary accessor for high-level stats * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * Update janitor/functions.py Co-Authored-By: ricky-lim <rlim.email@gmail.com> * first commit to io module with read_csvs * adding test for read_csvs, work in progress * update after the review * ensured pycodestyle compliance * fixed nb * updated boardgame nb * Adding the beautiful new logo to documentation * Fixed code style and format * Replaced inplace everywhere appropriately * Added Deprecation Warning for the reset_index_inplace method * Add example notebook tidytuesday_2019-04-23 * added a utils.py file in tests which contains a function which checks if a another function is idempotent. ALso added tests to check that the fucking ehaves as expected * Used black * spreadout the list comprehension for readibility * Rename to data_description * Formatting conf.py from docs * Small change to remove flake8 statement * Remove image from readme (doesn't render on github) * fixed format issues. Due to minor git mistakes, this push also includes docstring changes to certain function in janitor/functions.py such that the code in the docstring is executable * Cleaned up format to look cleaner in docs * added references * removed test/utils.py and placed the function within it into janitor/utils.py * minor changes to janitor/utils.y * test new doc architecture * Add test skip for checking Unix time on Windows * new index * Fixed length issue for pycodestyle * made sure there was 1 and only 1 extra line at the end of utils.py * Making Black happy! * Update janitor/functions.py Co-Authored-By: catherinedevlin <catherine.devlin@gmail.com> * add summary for functions, subheadings proposed by jk3587 * Added Deprecation message + ran black * adding function read_csvs to janitor.io * Add in multi-index groupby_agg and accompanying unit tests * create notebook example of replacing bad values with np.NaN * new doc architecture * Update the documentation. In the documentation table of contents rename Example notebooks to Examples. Remove the contributing info from the notebook pyjanitor_intro.ipynb. Remove the bold from pyjanitor in the top level title. Doing this to avoid bold in the documentation table of contents. Change so it is just one "top-level" title in the notebooks pyjanitor_intro and tidytuesday_20190423.ipynb. Change the order of the table of contents so the pyjaitor_intro notebook always is the first example. Add Installation in the table of contents. Change so the examples come before the API Documentation in the table of contents. * Make Black happy * fixed docstring for encode_categorical method * working demo of new doc architecture * Split out development dependencies into requirements-dev.txt Non-development users do not need to run tests, format code, build docs, so omitting those from requirements.txt reduces the package's size for them. * Added TOC header * Clearer unit test for multi-groupby * reformat with black * io.read_csvs restricts input to csvs with same columns * io.read_csvs: removed csv extension requirement * black formmatin to io.read_csvs * Get isort from conda-forge Without specifying a source, conda installation of isort fails * added tables describing bio, chem, finance, etc levels of pyjanitor * removed obsolete test csv files * fixed style issues * Add decorator to cleanly alias deprecated arguments * Update pull request template There should be (hopefully) more helpful hints in here. * Update README with pithy description of pyjanitor * Update CONTRIBUTING.rst Emphasized docs contributions first, and added rationales for a bunch of things. * Add bin_numeric to general functions Resolves #303. * Create ISSUE_TEMPLATE.md * Update pull_request_template.md Added some more contextual information requested. * Update pull_request_template.md * Create bug report template. * Delete ISSUE_TEMPLATE.md * Create documentation_fix.md * Create new_proposed_feature.md * Apply new alias decorator to previously updated functions with deprecated argument names * Create new_examples.md * Removed all document strings > 80 chars, split coalesce test into multiple * Update naming conventions in rename_column(), get_features_targets() * Update naming conventions in coalesce() and fill_empty() * Update naming conventions in concatenate_columns() and deconcatenate_column() * Update naming conventions in filter_string() and filter_column_isin() * Update naming conventions in change_type() and add_column() * Update naming conventions in min_max_scale() and remove_columns() * Update naming conventions for round_to_fraction(), transform_column(), transform_columns() * Update naming conventions for currency_column_to_numeric() and select_columns() * column_added * noindex on functions page to get rid of build errors * convert notebook readme to RST * comment out round_to_fraction example #329 * comment out example in row_to_names * add autosummary_generate to get rid of build errors * autogenerate janitor functions * pydocstyle fixes * applied black * fixed function docstrings using pydocstyle * finance header is now correct * merge conflict resolution * apply black and pycodestyle fixes * remove functions.rst * fix pydocstyle * fix linting issues * more docfixes * pycodestyle fix * black * re-run checks * fixed misnamed black command * [DOC] Normalization notebook (WIP) (#320) * Adding @jcvall's notebook of normalization examples Fleshed it out with explanatory text. Closes #135 * Cleared notebook output https://nbsphinx.readthedocs.io/en/latest/usage.html suggests clearing output * [DOC] Use readthedocs YAML v2 for building docs (#334) * [DOC] Update infrastructure for readthedocs (#335) * add readthedocs config * readthedocs fixes * add ipykernel to requirements-dev.txt * add seaborn to requirements-dev * [DOC] Remove example.py in examples directory (#337) * [TST] add skipif for biology (#338) * Update missing docstring parameters (#340) * Rename descriptors to descriptors_mapping in chemistry.py (#341) This helps silence mypy's complaints on `chemistry.py`. * [TST] Add codecov to build pipeline (#343) * re-enabled coverage * add uploading of coverage reports to test pipeline * add pytest-azurepipelines to dev requirements * add pytest-azurepipelines to environment-dev.yml * move pytest-azurepipelines to conda * move python-language-server to conda * move sphinxcontrib-fulltoc to conda * add token for codecov * Update Azure build badge (#350) Update Azure build status badge in README.rst * [ENH] Mega-refactoring (#349) * refactoring, changing type annotations * added deprecation. removed annotations for non list names * fixed docstring length issues * [ENH] move utility functions to utils.py (#356) * [ENH] Datadesc repr (#352) * add a repr to DataDesc * remove todo, fix docstring, move away from assertionerror * [DOC] various doc changes incl contributing (#353) * various doc changes * Update LICENSE Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com> * Update naming conventions for filter_date() (#358) * Fix tidytuesday_20190423 (#359) * [ENH] Add take_first function (#363) * Add take_first function * Add test for take_first * [DOC] Update general_functions with missing functions (#364) * Update general_functions with missing functions * add functions to docs * fix tests * separate out tests from code coverage * tests pass * Trying hotfix merge * Revert "Trying hotfix merge" This reverts commit 119ac398 * Pre-merge commit with current version * Condensed all documentation down to 80 char lines (except for links), added whitespace in line 459 that was causing azure build to fail. * Added tests for chemistry, finance, and the test_filter_column_isin function. * Added first of utils tests, changed documentation on "currency_column_to_numeric" for clarity. * Added full suite of utils tests, restored chemistry skipifs and filter_column_isin to their original state. * Fixed Sphinx display problem
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also resolves #348