self.__doc__

Thomas Waldmann @ GPN18

__doc__ in Python

In __doc__ können sich Objekte selbst beschreiben.

 

Aussprache:  "dunder doc" (aka docstring)

 

Man kann damit:

  • interaktiv Hilfe bekommen
     

  • Doku generieren (Sphinx und andere Tools)
     
  • ganz normal via Python verwenden -
    der Code kommt an seine eigene Doku ran.

Beispiel

class OrderedDict:
    """a key->value mapping that remembers insert order"""

    ...

    
>>> help(OrderedDict)
'a key->value mapping ...'


>>> print(OrderedDict.__doc__)
'a key->value mapping ...'

 

Man muss nicht rätseln was es macht, dokumentiert sich selbst.

AND  NOW

FOR SOMETHING

COMPLETELY

DIFFERENT.

Real Life Doc Issues

 

  • Konferenzen, Hackerspaces, Hackcenter, ...
     
  • viele (nicht pers. bekannte) Menschen,
     

  • die an potentiell Interessantem arbeiten,
     
  • aber keine / wenig Doku.

$Leute tun $Dinge.

$Leute2 tun $Dinge2.

Das Problem

  • alle machen irgendwas - aber was?
     
  • einfach anquatschen?
     
  • kann man machen,
    trauen sich aber viele nicht.

     
  • und selbst wenn:
    skaliert nicht, irgendwie ineffektiv bei N > 10.

 

__doc__ to the rescue!

  • dokumentiert Euch selbst,
    lest Docs anderer Leute.

     
  • Papier, Bildschirm, Beamer, Poster, T-Shirt
     
  • wenige, gut lesbare Stichworte
    (auf 2m Abstand, im vorbei Laufen)
     
  • was Euch interessiert,
    was Euch begeistert,
    woran Ihr arbeitet / gearbeitet habt, ...
ThomasWaldmann.__doc__

 

ESP32 / MicroPython / ULP

(powerful MicroController)

BorgBackup

(deduplicating Backup Software)

nsupdate.info

(dyndns Service / Software)

MoinMoin Wiki

(Wiki-Software)

 

Python / Linux / FOSS

Crypto / Privacy

Name/Nick.__doc__

 

Fett/Groß:

wenige,
im Event-Kontext relevante Stichworte

 

(darunter ggf. mehr Details / Erklärung, kleiner Font)

 

Optional:
in bunt, HomePage, github, ...

 

Assemblies

  • Thematische Assemblies helfen:
    • damit ist grob klar, worum's geht.
    • helfen, neue Leute mit ähnlichen Interessen zu treffen.
    • Leute zu bestimmten Themen treffen.
       
  • Lokal-Assemblies sind eher abträglich:
    • Hackerspace Bärburg Assembly = zusammensitzen mit Leuten, mit denen man sonst auch zusammen sitzt.
    • oft ohne spezifisches Thema

https://slides.com/ thomaswaldmann/ self-doc

 

Lizenz:  WTFPL

Bitte weitersagen / weiterverwenden:

self.__doc__

By Thomas Waldmann

self.__doc__

  • 383
Loading comments...

More from Thomas Waldmann