-
Notifications
You must be signed in to change notification settings - Fork 86
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #872 +/- ##
=======================================
Coverage 99.74% 99.74%
=======================================
Files 195 195
Lines 8365 8365
=======================================
Hits 8344 8344
Misses 21 21
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One little thing about change log but otherwise looks good to me!
docs/source/changelog.rst
Outdated
@@ -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` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@freddyaboulton thanks for this! All helpful. +1 to @jeremyliweishih comment about Documentation
header in changelog but no changes requested other than that.
Thanks for the feedback @dsherry and @jeremyliweishih ! |
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
.