Skip to content

fix README for PyPI #643

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

Merged
merged 1 commit into from
Feb 14, 2019
Merged

fix README for PyPI #643

merged 1 commit into from
Feb 14, 2019

Conversation

ChoiByungWook
Copy link
Contributor

@ChoiByungWook ChoiByungWook commented Feb 14, 2019

Issue #, if available:
The README doc is broken in PyPI: https://pypi.org/project/sagemaker/1.18.3/

The code snippet below was missing a newline.

Twine provides the ability to check if your readme will render properly on PyPI.
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

aws/sagemaker-tensorflow-extensions#32

Description of changes:
Added newline in code snippet portion in README.
Bumped to 1.18.3.post1

Going to add the step in our CI.

=== TEST ===
twine check dist/*
/anaconda3/lib/python3.6/site-packages/readme_renderer/markdown.py:38: UserWarning: Markdown renderers are not available. Install 'readme_render[md]' to enable Markdown rendering.
warnings.warn(_EXTRA_WARNING)
Checking distribution dist/sagemaker-1.18.3.post1.tar.gz: Passed

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have updated the changelog with a description of my changes (if appropriate)
  • I have updated any necessary documentation (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov-io
Copy link

Codecov Report

Merging #643 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #643      +/-   ##
==========================================
+ Coverage   92.75%   92.77%   +0.01%     
==========================================
  Files          71       71              
  Lines        5465     5465              
==========================================
+ Hits         5069     5070       +1     
+ Misses        396      395       -1
Impacted Files Coverage Δ
src/sagemaker/amazon/common.py 97.01% <0%> (+0.74%) ⬆️

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 2af36ad...e376c1f. Read the comment docs.

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.

3 participants