Mitarbeit an offizieller Python-Doku ???

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
Antworten
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Freitag 22. April 2005, 11:34

Weiß jemand wie man Wünsche, Änderungen an der offiziellen Python Doku einreichen kann???

z.B. währe beim shelve gut zu wissen, was man mit den Parametern [,flag='c'[,protocol=None[,writeback=False[,binary=None]]]] genaues erreichen kann...

Bei anydbm ist flag beispielsweise erklärt:

Code: Alles auswählen

The optional flag argument can be 'r' to open an existing database for reading only, 'w' to open an existing database for reading and writing, 'c' to create the database if it doesn't exist, or 'n', which will always create a new empty database. If not specified, the default value is 'r'.

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
Leonidas
Administrator
Beiträge: 16024
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Freitag 22. April 2005, 12:43

Ich würde es in den Python Trackern eintragen.
My god, it's full of CARs! | Leonidasvoice vs Modvoice
BlackJack

Freitag 22. April 2005, 23:34

jens hat geschrieben:Weiß jemand wie man Wünsche, Änderungen an der offiziellen Python Doku einreichen kann???

z.B. währe beim shelve gut zu wissen, was man mit den Parametern [,flag='c'[,protocol=None[,writeback=False[,binary=None]]]] genaues erreichen kann...
Das steht doch alles in der Doku!? Was genau hättest Du denn gerne dort geändert?
CM
User
Beiträge: 2464
Registriert: Sonntag 29. August 2004, 19:47
Kontaktdaten:

Samstag 23. April 2005, 01:22

Hoi,

an manchen Stellen ist die Doku wirklich dürftig. Das ist aber normal und die Python-doku ist schon verdammt gut.
Aber weil man wohl weiß, das man nicht perfekt ist, gibt es diesen Link: http://www.python.org/dev/doc/devel/about.html mit der entsprechenden email-Adresse.

Finde ich auch irgendwie passender als die "Python Tracker". Allerdings, da hat BlackJack Recht, sollte man sich schon Gedanken machen, was genau wie in der Doku stehen soll. Das ist gar nicht so trivial, wie es manchmal scheint. Wenn Du Hilfe gebrauchen kannst, einfach fragen.

Gruß,
Christian
Gast

Samstag 23. April 2005, 10:42

BlackJack hat geschrieben:Das steht doch alles in der Doku!? Was genau hättest Du denn gerne dort geändert?
Bei shelve steht nicht's zu flag, protocol, writeback und binary! Oder bin ich blind???

http://www.python.org/dev/doc/devel/about.html ist eine gute Adresse ;) Dort steht klar, das Kommentare an docs@python.org geschickt werden sollen und Fehler in den Python Bug Tracker.
Benutzeravatar
jens
Moderator
Beiträge: 8461
Registriert: Dienstag 10. August 2004, 09:40
Wohnort: duisburg
Kontaktdaten:

Samstag 23. April 2005, 10:47

Ups, das wahr ich... Und blind bin ich anscheinend / ich sollte den Text auch mal richtig lesen :oops:
Bei shelve steht:
The optional flag parameter has the same interpretation as the flag parameter of anydbm.open.
Aber ist es nicht besser, wenn dort die Informationen direkt stehen? Zumal anydbm.open() kein Link ist :(

Also meiner Meinung nach sollte da statt des Satzes oben, besser das stehen:
The optional flag argument can be 'r' to open an existing database for reading only, 'w' to open an existing database for reading and writing, 'c' to create the database if it doesn't exist, or 'n', which will always create a new empty database. If not specified, the default value is 'r'.

CMS in Python: http://www.pylucid.org
GitHub | Open HUB | Xing | Linked in
Bitcoins to: 1JEgSQepxGjdprNedC9tXQWLpS424AL8cd
Antworten