Mailman 3 September 2020 - Doc-SIG

Status for Transifex-based translations
by Maciek Olko Aug. 1, 2021

Aug. 1, 2021

Hello, I want to share with you a small script that displays translation status for language switcher for Transifex-based translations. The script is using Transifex API [1] and requires Transifex API token. https://github.com/m-aciek/python-docs-pl-status/blob/master/checkstatus.py It generates README.md file with status. Currently, for Polish translation it is 5.17%. Regards, Maciej [1] https://docs.transifex.com/api/resources [2] https://github.com/m-aciek/python-docs-pl-status

3 6

Broken link on documentation header
by tomo cocoa Oct. 19, 2020

Oct. 19, 2020

Hi Julien, perhaps can you understand the reasons that the link "Documentation" on the head of the top page leads 404 pages? [image: Screen Shot 2020-09-11 at 22.10.37.png] This trouble occurs all language documentation except English. -- class Cocoatomo: name = 'cocoatomo' email_address = 'cocoatomo77(a)gmail.com' twitter_id = '@cocoatomo'

2 2

PEP257 Suggestion : semicolons use for attribute docstrings
by Erik Aronesty Oct. 16, 2020

Oct. 16, 2020

I wasn't sure where to post this, maybe a mailing list? PEP-257: String literals occurring immediately after a simple assignment at the top level of a module, class, or __init__ method are called "attribute docstrings". ```python class Foo: attr = 1 """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" some_other_attr = 'is this the one we're documenting?' ``` A semicolon is a natural delimiter for single-line attribute docstrings. ```python class Foo: # pylint: disable=multiple-statements attr = 1; """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" some_other_attr = 'is this the one we're documenting?' ``` The PEP style is obviously unclear. Docstrings, in general, are hard to format well... the simplest rule is that they must be visually linked to the thing they are documenting. Fortunately, the semicolon allows us to visually connect a single-line docstring to its attribute -as long as the line-length is short. As an alternative a comment or something could provide visual cues, and if this is the standard, it should be added to the PEP on docstrings. ```python class Foo: attr = 1; """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" # ----- some_other_attr = 'is this the one we're documenting?' ```

2 1

The translation team of ko_KR is needed?
by tomo cocoa Sept. 11, 2020

Sept. 11, 2020

Hi, all I wonder why 26 members belong to the ko_KR team, while 68 members belong to the Korean team. IMHO, It is more efficient to gather on one side, and I want to merge the two teams. Let me know when you have some suggestions, reasons, and comments. Thanks. -- class Cocoatomo: name = 'cocoatomo' email_address = 'cocoatomo77(a)gmail.com' twitter_id = '@cocoatomo'

1 0