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 tutorials / documentation #156

Merged
merged 7 commits into from Nov 7, 2019
Merged

Fix typos in tutorials / documentation #156

merged 7 commits into from Nov 7, 2019

Conversation

alessiamarcolini
Copy link
Contributor

@alessiamarcolini alessiamarcolini commented Oct 31, 2019

Motivation and Context

Why is this change required? What problem does it solve?:

Tutorials documentation updated / fixed typos

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Documentation update
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Is this PR ready for review, or a work in progress?

  • Ready for review
  • Work in progress

How Has This Been Tested?

Put an x in the boxes that apply:

  • Current tests cover modifications made
  • New tests have been added to the test suite
  • Modifications were made to existing tests to support these changes
  • Tests may be needed, but they are not included when the PR was proposed
  • I don't know. Help!

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have signed (or will sign when prompted) the tensorwork CLA.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@alessiamarcolini alessiamarcolini changed the title Typos docs Fix typos in documentation / tutorials Oct 31, 2019
@CLAassistant
Copy link

CLAassistant commented Oct 31, 2019

CLA assistant check
All committers have signed the CLA.

@alessiamarcolini alessiamarcolini changed the title Fix typos in documentation / tutorials Fix typos in tutorials Oct 31, 2019
@codecov
Copy link

codecov bot commented Oct 31, 2019

Codecov Report

Merging #156 into master will decrease coverage by 0.07%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #156      +/-   ##
==========================================
- Coverage   95.23%   95.16%   -0.07%     
==========================================
  Files          63       63              
  Lines       11196    11196              
  Branches      964      964              
==========================================
- Hits        10662    10654       -8     
- Misses        356      360       +4     
- Partials      178      182       +4
Impacted Files Coverage Δ
tests/property_based/conftest.py 100% <ø> (ø) ⬆️
src/hangar/cli/cli.py 89.52% <ø> (ø) ⬆️
tests/property_based/test_pbt_arrayset.py 100% <100%> (ø) ⬆️
tests/property_based/test_pbt_metadata.py 100% <100%> (ø) ⬆️
src/hangar/metadata.py 92.91% <0%> (-2.36%) ⬇️
src/hangar/context.py 93.04% <0%> (-1.27%) ⬇️
tests/test_remotes.py 97.97% <0%> (-0.55%) ⬇️

@alessiamarcolini alessiamarcolini changed the title Fix typos in tutorials Fix typos in tutorials / documentation Oct 31, 2019
@rlizzo
Copy link
Member

rlizzo commented Nov 4, 2019

Hey @alessiamarcolini Thanks for the Pull Request! so sorry this took so long to get to.

Can you try rebasing off of the current master branch and resubmit?

Thanks!

…ons and autoinclude any necessary method docstrings inline in tutorials
@rlizzo rlizzo self-assigned this Nov 7, 2019
Copy link
Member

@rlizzo rlizzo left a comment

Choose a reason for hiding this comment

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

Hey @alessiamarcolini I just sent in a few updates (improved linking to API docs and inline docstring generation in tutorials) to go along with your documentation fixes. Also fixed the issue with the failing tests (sorry about that!)

These are great, I've included your contribution in the CHANGELOG, and am approving this merge.

Thanks so much for your hard work and contribution!

@rlizzo rlizzo merged commit 1d932c8 into tensorwerk:master Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants