Skip to content

Commit bb62ae7

Browse files
committed
More detail about render failure.
The note about readme-renderer has been moved to the new FAQ item with a pointer from its previous location.
1 parent c5a2627 commit bb62ae7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

warehouse/templates/pages/help.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ <h3 id="request-ownership">{{ request_ownership() }}</h3>
569569
<h3 id="description-content-type">{{ description_content_type() }}</h3>
570570
<p>{% trans href='http://docutils.sourceforge.net/rst.html', title=gettext('External link') %}By default, an upload's description will render with <a href="{{ href }}" title="{{ title }}" target="_blank" rel="noopener">reStructuredText</a>. If the description is in an alternate format like Markdown, a package may set the <code>long_description_content_type</code> in <code>setup.py</code> to the alternate format.{% endtrans %}</p>
571571
<p>{% trans href='https://packaging.python.org/tutorials/distributing-packages/#description', title=gettext('External link') %}Refer to the <a href="{{ href }}" title="{{ title }}" target="_blank" rel="noopener">Python Packaging User Guide</a> for details on the available formats.{% endtrans %}</p>
572-
<p>{% trans href='https://pypi.org/project/readme_renderer/' %}PyPI will reject uploads if the description fails to render. To check a description locally for validity, you may use <a href="{{ href }}">readme_renderer</a>, which is the same description renderer used by PyPI.{% endtrans %}</p>
572+
<p>For how to check a description for validity, see also: <a href="#description-render-failure">{{ description_render_failure() }}</a></p>
573573

574574
<h3 id="file-size-limit">{{ file_size_limit() }}</h3>
575575
<p>
@@ -626,6 +626,13 @@ <h3 id="vulnerability-data">{{ vulnerability_data() }}</h3>
626626
<section class="faq-group" id="troubleshooting">
627627
<h2>{% trans %}Troubleshooting{% endtrans %}</h2>
628628

629+
<h3 id="description-render-failure">{{ description_render_failure() }}</h3>
630+
<p>
631+
{% trans trimmed readme_renderer_href='https://pypi.org/project/readme_renderer/', twine_check_href='https://twine.readthedocs.io/en/latest/#twine-check', title=gettext('External link') %}
632+
PyPI will reject uploads if the package description fails to render. You may <a href="{{ twine_check_href }}" title="{{ title }}">use twine's check command</a> or <a href="{{ readme_renderer_href }}">readme_renderer</a>, the same description renderer used by PyPI, to locally check a description for validity.
633+
{% endtrans %}
634+
</p>
635+
629636
<h3 id="login-problem">{{ login_problem() }}</h3>
630637
<p>{% trans %}If you've forgotten your PyPI password but you remember your email address or username, follow these steps to reset your password:{% endtrans %}</p>
631638
<ol>
@@ -865,13 +872,6 @@ <h3 id="pronunciation">{{ pronunciation() }}</h3>
865872
{% endtrans %}
866873
</p>
867874

868-
<h3 id="description-render-failure">{{ description_render_failure() }}</h3>
869-
<p>
870-
{% trans trimmed href='https://twine.readthedocs.io/en/latest/#twine-check', title=gettext('External link') %}
871-
To diagnose a description render error, use twine's <a href="{{ href }}" title="{{ title }}">check command</a>.
872-
{% endtrans %}
873-
</p>
874-
875875
</section>
876876
</div>
877877
</div>

0 commit comments

Comments
 (0)