Ambiguity in the Structure section.

Offen
#454 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne mit dem Abschnitt Modules in docs/writing/structure.rst und verwende den verknüpften Abschnitt als Umfang. Bestätige die beabsichtigte Bedeutung anhand der bestehenden Diskussion und überarbeite die Formulierung nur, wenn diese Bedeutung eindeutig ist; abgeschlossen ist die Arbeit, wenn der gerenderte Abschnitt eindeutig ist und die ursprüngliche Anleitung bewahrt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I'm a little confused as to what this passage from writing/structure means.

Readability means to avoid useless boilerplate text and clutter,
therefore some efforts are spent trying to achieve a certain level of brevity.
But terseness and obscurity are the limits where brevity should stop. 

Could this be reworded as something like this?

Readability in this case refers to avoiding useless boilerplate text and
clutter, and some effort has been made to achieve a certain level of brevity
in Python's syntax. However, there is a fine line between terseness and
obscurity.

I'm not sure I'm correctly grasping the meaning of the text. Does it actually mean something completely different?

Vorherrschende Sprache
Batchfile
Sterne
29.8k
Forks
5.9k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus realpython/python-guide

Alle Issues in realpython/python-guide

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.