Skip to content

Commit 4833227

Browse files
authored
Suggest twine-check
To diagnose description render failures.
1 parent 2c587c1 commit 4833227

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

warehouse/templates/pages/help.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
{% macro file_size_limit() %}{% trans %}How do I get a file size limit exemption or increase for my project?{% endtrans %}{% endmacro %}
8484
{% macro project_size_limit() %}{% trans %}How do I get a total project size limit exemption or increase for my project?{% endtrans %}{% endmacro %}
8585
{% macro vulnerability_data() %}{% trans %}Where does PyPI get its data on project vulnerabilities from, and how can I correct it?{% endtrans %}{% endmacro %}
86-
86+
{% macro description_render_failure() %}{% trans %}Why am I getting "the description failed to render" error?{% endtrans %}{% endmacro %}
8787

8888
{% macro file_name_reuse() %}{% trans %}Why am I getting a "Filename or contents already exists" or "Filename has been previously used" error?{% endtrans %}{% endmacro %}
8989
{% macro project_name() %}{% trans %}Why isn't my desired project name available?{% endtrans %}{% endmacro %}
@@ -165,6 +165,7 @@ <h2><a href="#administration">{% trans %}Administration of projects on PyPI{% en
165165
<section class="faq-group faq-group--list">
166166
<h2><a href="#troubleshooting">{% trans %}Troubleshooting{% endtrans %}</a></h2>
167167
<ul>
168+
<li><a href="#description-render-failure">{{ description_render_failure() }}</a></li>
168169
<li><a href="#uploading">{{ uploading() }}</a></li>
169170
<li><a href="#login-problem">{{ login_problem() }}</a></li>
170171
<li><a href="#account-recovery">{{ account_recovery() }}</a></li>
@@ -864,6 +865,13 @@ <h3 id="pronunciation">{{ pronunciation() }}</h3>
864865
{% endtrans %}
865866
</p>
866867

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+
867875
</section>
868876
</div>
869877
</div>

0 commit comments

Comments
 (0)