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

Removes line break in README.rst #35

Merged
merged 2 commits into from
May 15, 2020
Merged

Removes line break in README.rst #35

merged 2 commits into from
May 15, 2020

Conversation

antalszava
Copy link
Contributor

  • Removes a line break in README.rst such that it will render on PyPi

@codecov
Copy link

codecov bot commented May 14, 2020

Codecov Report

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

@@           Coverage Diff           @@
##           master      #35   +/-   ##
=======================================
  Coverage   96.59%   96.59%           
=======================================
  Files           6        6           
  Lines         176      176           
=======================================
  Hits          170      170           
  Misses          6        6           

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 f83b241...e36eb75. Read the comment docs.

@antalszava antalszava requested a review from josh146 May 14, 2020 23:31
@antalszava
Copy link
Contributor Author

tl;dr:

Further changes were needed in Readme.rst

More details

Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 75: Error: Unknown directive type "highlight".

    .. highlight:: bash
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Checking dist/PennyLane-SF-0.9.0.tar.gz: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 75: Error: Unknown directive type "highlight".

    .. highlight:: bash
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Solution: remove line with highlight

Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 2: Warning: Duplicate explicit target name: "pennylane".
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Checking dist/PennyLane-SF-0.9.0.tar.gz: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 2: Warning: Duplicate explicit target name: "pennylane".
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Solution: use double underscores as suggested here sphinx-doc/sphinx#3921 (comment)

Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 107: Error: Unknown interpreted text role "file".
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Solution: make :file: into highlighting with double backticks

Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line : Error: Anonymous hyperlink mismatch: 1 references but 0 targets.
    See "backrefs" attribute for IDs.
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line : Error: Anonymous hyperlink mismatch: 1 references but 0 targets.
    See "backrefs" attribute for IDs.
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: FAILED
  `long_description` has syntax errors in markup and would not be rendered on PyPI.
    line 42: Error: Unknown target name: "https://pennylane-sf.readthedocs.io/en/latest/".
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.


Checking dist/PennyLane_SF-0.9.0-py3-none-any.whl: PASSED, with warnings
  warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.

Slution: naming the hyperlink

@antalszava antalszava requested a review from josh146 May 15, 2020 03:33
Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

Thanks Antal, it looks like PyPI has become a lot stricter since the last time we released this plugin!

@antalszava
Copy link
Contributor Author

sure, thanks for the re-review! 😊 was also wondering too, turned out we had changes to README.rst file in a recent PR

@antalszava antalszava merged commit b2e2083 into master May 15, 2020
@antalszava antalszava deleted the update_readme branch May 15, 2020 03:44
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.

2 participants