Hallo,
collections.Counter ist eigentlich eine total simple und praktische Sache.
Aber die Doku ist irgendwie nicht simple:
https://docs.python.org/2/library/collections.html#collections.Counter
Hat jemand eine Idee wie man die Doku verbessern könnte?
Oder sehe ich das falsch und die Doku ist schon super (insbesondere aus dem Blickwinkel eines Anfängers)?
Gruß, Thomas
Was soll an der Doku verkehrt sein?
Regards Andreas Jung ----- Sorry for being brief - sent from a mobile device.
Am 28.01.2015 um 21:11 schrieb Thomas Güttler guettliml@thomas-guettler.de:
Hallo,
collections.Counter ist eigentlich eine total simple und praktische Sache.
Aber die Doku ist irgendwie nicht simple:
https://docs.python.org/2/library/collections.html#collections.Counter
Hat jemand eine Idee wie man die Doku verbessern könnte?
Oder sehe ich das falsch und die Doku ist schon super (insbesondere aus dem Blickwinkel eines Anfängers)?
Gruß, Thomas
-- http://www.thomas-guettler.de/ _______________________________________________ python-de maillist - python-de@python.org https://mail.python.org/mailman/listinfo/python-de
Am 28.01.2015 um 21:22 schrieb Andreas Jung:
Was soll an der Doku verkehrt sein?
Ich weiß auch nicht, was daran falsch ist, aber zumindest dieses Beispiel
>>> c = Counter('gallahad') # a new counter from an iterable
kann, wenn man sich nicht bewusst macht, dass Strings auch Iterables sind, flasche Vorstellungen über das Ergebnis provozieren. Dass da dieses rauskommt:
>>> c.keys() dict_keys(['a', 'l', 'd', 'h', 'g'])
hätte man evtl. auch zeigen sollen.
Chris
Unsinnige Diskussion am falschen Platz. Es gibt keine perfekte Doku. Man kann es eh niemanden recht machen.
Regards Andreas Jung ----- Sorry for being brief - sent from a mobile device.
Am 28.01.2015 um 22:09 schrieb Christopher Arndt chris@chrisarndt.de:
Am 28.01.2015 um 21:22 schrieb Andreas Jung: Was soll an der Doku verkehrt sein?
Ich weiß auch nicht, was daran falsch ist, aber zumindest dieses Beispiel
c = Counter('gallahad') # a new counter from an iterable
kann, wenn man sich nicht bewusst macht, dass Strings auch Iterables sind, flasche Vorstellungen über das Ergebnis provozieren. Dass da dieses rauskommt:
c.keys()
dict_keys(['a', 'l', 'd', 'h', 'g'])
hätte man evtl. auch zeigen sollen.
Chris
python-de maillist - python-de@python.org https://mail.python.org/mailman/listinfo/python-de
Am 28.01.2015 um 21:22 schrieb Andreas Jung:
Was soll an der Doku verkehrt sein?
Ich komme mit der Doku zurecht. Ich nutze Python seit 14 Jahren.
Wenn ich Neulingen in unserer Firma die Doku zeige, und wir die zusammen anschauen. Dann merke ich, dass die Doku von Counter nicht intuitiv und sofort verstanden wird.
Sicherlich kann man es nicht allen Recht machen. Aber ganz allgemein, sollte die Doku primär für Neulinge leicht verständlich sein. Oder?
Danach können gerne die trickreichen Sonderfälle erläutert werden.
Die Übergabe einer Zeichenkette, die dann als Liste behandelt wird, ist für Neulinge eher verwirrend.
Gruß, Thomas
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
Thomas Güttler wrote:
Am 28.01.2015 um 21:22 schrieb Andreas Jung:
Was soll an der Doku verkehrt sein?
Ich komme mit der Doku zurecht. Ich nutze Python seit 14 Jahren.
Wenn ich Neulingen in unserer Firma die Doku zeige, und wir die zusammen anschauen. Dann merke ich, dass die Doku von Counter nicht intuitiv und sofort verstanden wird.
Sicherlich kann man es nicht allen Recht machen. Aber ganz allgemein, sollte die Doku primär für Neulinge leicht verständlich sein. Oder?
Danach können gerne die trickreichen Sonderfälle erläutert werden.
Die Übergabe einer Zeichenkette, die dann als Liste behandelt wird, ist für Neulinge eher verwirrend.
Gruß, Thomas
Und was lernen wir aus dieser Diskussion? Entweder nichts oder dass man zur Python Dokumentation selber beitragen sollte, wenn etwas nicht stimmt.
- -- Regards Andreas Jung andreas@andreas-jung.com about.me/andreasjung
participants (3)
-
Andreas Jung -
Christopher Arndt -
Thomas Güttler