Skip to content

Add links to source and download #83

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

StanFromIreland
Copy link
Collaborator

@StanFromIreland StanFromIreland commented Apr 2, 2025

Also added translations count and split the footer from the informational text.


📊 Dashboard preview 📊: https://python-docs-translations.github.io/dashboard/83/merge/

@StanFromIreland StanFromIreland requested a review from m-aciek April 2, 2025 16:00
Comment on lines +58 to +60
Currently being translated into <strong>{{ completion_progress|length }}</strong> languages.
The documentation has a word count of {{ '{:,}'.format(word_count) }}.
For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/">Python Developer’s Guide</a> and <a href="https://peps.python.org/pep-0545/">PEP 545</a>.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Awkward wording, any ideas on how to improve?

@StanFromIreland StanFromIreland linked an issue Apr 2, 2025 that may be closed by this pull request
<p>The Python documentation currently has a word count of {{ '{:,}'.format(word_count) }}.</p>
<p>For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/">Python Developer’s Guide</a>.</p>
<p>Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
<h3>Python Documentation</h3>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think there's no need to introduce heading and a separate footer. I'd keep the regular three paragraphs.

<p>Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
<h3>Python Documentation</h3>
<p>
Currently being translated into <strong>{{ completion_progress|length }}</strong> languages.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably a matter of taste, in my opinion there's no need to emphasise the number (<strong>).

Comment on lines +56 to +60
<h3>Python Documentation</h3>
<p>
Currently being translated into <strong>{{ completion_progress|length }}</strong> languages.
The documentation has a word count of {{ '{:,}'.format(word_count) }}.
For more information about translations, see the <a href="https://devguide.python.org/documentation/translating/">Python Developer’s Guide</a> and <a href="https://peps.python.org/pep-0545/">PEP 545</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

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

PEP 545 is linked at the top of the linked chapter of the developer's guide, I'd keep one link in this sentence for simplicity.

</p>
<footer>
<hr>
<p>You can download the data on this page in <code>.json</code> format <a href="https://github.com/python-docs-translations/dashboard/blob/gh-pages/index.json">here</a>, and you can also find the scripts used to generate this page <a href="https://github.com/python-docs-translations/dashboard">here</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<p>You can download the data on this page in <code>.json</code> format <a href="https://github.com/python-docs-translations/dashboard/blob/gh-pages/index.json">here</a>, and you can also find the scripts used to generate this page <a href="https://github.com/python-docs-translations/dashboard">here</a>.
<p>You can download the data on this page in <a href="https://github.com/python-docs-translations/dashboard/blob/gh-pages/index.json">JSON format</a>. You can also find the scripts used to generate those pages or contribute <a href="https://github.com/python-docs-translations/dashboard">here</a>.

Comment on lines +40 to +44
<footer>
<hr>
<p>You can find the scripts used to generate this page <a href="https://github.com/python-docs-translations/dashboard">here</a>.</p>
<p>Last updated at {{ generation_time.strftime('%A, %-d %B %Y, %-H:%M:%S %Z') }} (in {{ duration // 60 }}:{{ "{:02}".format(duration % 60) }} minutes).</p>
</footer>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd leave only "last updated" paragraph on the metadata page as a regular paragraph.

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.

Link to index.json
2 participants