From cocoatomo77 at gmail.com Fri Sep 11 08:23:52 2020 From: cocoatomo77 at gmail.com (tomo cocoa) Date: Fri, 11 Sep 2020 21:23:52 +0900 Subject: [Doc-SIG] The translation team of ko_KR is needed? Message-ID: 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 at gmail.com' twitter_id = '@cocoatomo' -------------- next part -------------- An HTML attachment was scrubbed... URL: From cocoatomo77 at gmail.com Fri Sep 11 09:20:14 2020 From: cocoatomo77 at gmail.com (tomo cocoa) Date: Fri, 11 Sep 2020 22:20:14 +0900 Subject: [Doc-SIG] Broken link on documentation header Message-ID: 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 at gmail.com' twitter_id = '@cocoatomo' -------------- next part -------------- An HTML attachment was scrubbed... URL: -------------- next part -------------- A non-text attachment was scrubbed... Name: Screen Shot 2020-09-11 at 22.10.37.png Type: image/png Size: 51351 bytes Desc: not available URL: From erik at q32.com Fri Sep 11 15:18:35 2020 From: erik at q32.com (Erik Aronesty) Date: Fri, 11 Sep 2020 15:18:35 -0400 Subject: [Doc-SIG] PEP257 Suggestion : semicolons use for attribute docstrings Message-ID: 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?' ```