[pyar] Falta de ejemplos en doc.

[Facundo Batista]

2012/4/9 Sebastian Bassi <sebastian.bassi en globant.com>:

> Veo que pocos de los métodos descripts ahi tiene ejemplo.
> Mi pregunta es: ¿Esto es una decisión tipo "los ejemplos no hacen falta,
> para ver como funciona miro la fuente" o siemplemente que nadie dió una mano
> subiendo ejemplos?

En general, hay dos tipos de filosofías:

- esto no es una colección de ejemplos, sino una especificación;
deberías poder saber todo el comportamiento con lo que describo

- te pongo ejemplos y ejemplos porque soy malo explicando y lo vas a
entender más fácil.

Ambas son incorrectas. La documentación de Python debería:

- ser lo suficientemente cierta como  para explicar el comportamiento
en el texto, con todos sus detalles

- proveer ejemplos en los casos de uso más normales, porque es una
buena forma de empezar a probar tal o cual función, cuando uno nunca
la usó

Si encontrás ejemplos donde alguno de estos dos últimos ejemplos no se
cumplen, patches welcomed ;) (parches a la documentación son
notablemente rápidamente aceptados).

Tené en cuenta que los ejemplos tienen que ser útiles... meter algo como...

>>> os.getpid()
29369

...es al cuete.

Slds.

-- 
.    Facundo

Blog: http://www.taniquetil.com.ar/plog/
PyAr: http://www.python.org/ar/