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

Fix Typos in Documentation #872

Merged
merged 4 commits into from Jun 23, 2020
Merged

Fix Typos in Documentation #872

merged 4 commits into from Jun 23, 2020

Conversation

freddyaboulton
Copy link
Contributor

@freddyaboulton freddyaboulton commented Jun 22, 2020

Pull Request Description

A small first step towards completing #861.

Fixes minor typos in the documentation, adds periods to docstring summary lines, and updates the Evalml logo in the docs.

I added periods to summary lines to be consistent with the napoleon and PEP style guides.

I was not able to update the favicon.


After creating the pull request: in order to pass the changelog_updated check you will need to update the "Future Release" section of docs/source/changelog.rst to include this pull request by adding :pr:123.

@codecov
Copy link

codecov bot commented Jun 22, 2020

Codecov Report

Merging #872 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #872   +/-   ##
=======================================
  Coverage   99.74%   99.74%           
=======================================
  Files         195      195           
  Lines        8365     8365           
=======================================
  Hits         8344     8344           
  Misses         21       21           
Impacted Files Coverage Δ
evalml/automl/auto_classification_search.py 100.00% <ø> (ø)
evalml/automl/auto_regression_search.py 100.00% <ø> (ø)
evalml/data_checks/data_check_message_type.py 100.00% <ø> (ø)
evalml/objectives/fraud_cost.py 100.00% <ø> (ø)
evalml/objectives/lead_scoring.py 100.00% <ø> (ø)
evalml/objectives/standard_metrics.py 100.00% <ø> (ø)
evalml/pipelines/classification/baseline_binary.py 100.00% <ø> (ø)
...ml/pipelines/classification/baseline_multiclass.py 100.00% <ø> (ø)
...alml/pipelines/classification/elasticnet_binary.py 100.00% <ø> (ø)
.../pipelines/classification/elasticnet_multiclass.py 100.00% <ø> (ø)
... and 41 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8bf3df5...d23b66a. Read the comment docs.

@freddyaboulton freddyaboulton linked an issue Jun 23, 2020 that may be closed by this pull request
@freddyaboulton freddyaboulton self-assigned this Jun 23, 2020
@freddyaboulton freddyaboulton marked this pull request as ready for review Jun 23, 2020
Copy link
Contributor

@jeremyliweishih jeremyliweishih left a comment

One little thing about change log but otherwise looks good to me!

@@ -22,6 +22,7 @@ Changelog
* Enforce requirement that builtin components save all inputted values in their parameters dict :pr:`847`
* Don't list base classes in `all_components` output :pr:`847`
* Standardize all components to output pandas datastructures, and accept either pandas or numpy :pr:`853`
* Minor updates to documentation :pr:`872`
Copy link
Contributor

@jeremyliweishih jeremyliweishih Jun 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a bullet for * Documentation Changes like so in the past releases for this?

Copy link
Contributor Author

@freddyaboulton freddyaboulton Jun 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

Copy link
Collaborator

@dsherry dsherry left a comment

@freddyaboulton thanks for this! All helpful. +1 to @jeremyliweishih comment about Documentation header in changelog but no changes requested other than that.

@freddyaboulton
Copy link
Contributor Author

freddyaboulton commented Jun 23, 2020

Thanks for the feedback @dsherry and @jeremyliweishih !

@freddyaboulton freddyaboulton merged commit d63209e into master Jun 23, 2020
2 checks passed
@angela97lin angela97lin mentioned this pull request Jun 30, 2020
@freddyaboulton freddyaboulton deleted the fix-documentation-typos branch Jul 10, 2020
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.

None yet

3 participants