Documentacion ruby de calidad


#1

Hola a tod@s,
tras unos pequeños desarrollos en ruby on rails me he creado una opinion
sobre ruby on rails. La primera es que es un framework muy potente sobre
un lenguaje con muchas posibilidades, la otra que la documentacion que
yo he visto no esta a la altura.

Si buscas informacion sobre un metodo, te describen el prototipo del
mismo y una breve descripcion de lo que hace pero rara vez te dice Qué
clase de objetos son sus parametros y qué clase de objeto devuelve.
Porque evidentemente es un foco de confusiones y errores.

Mi pregunta es, ¿existe una documentacion en la que se aclare este tipo
de informacion sobre cada metodo? sin ella no me siento seguro para
abordar un proyecto oficial, pues si al cliente le da por pedir una
chorrada que no encuentre en la documentacion supondra dias de busqueda
y pruebas que suponene un coste elevado.

Gracias por todo.


#2

On May 2, 2007, at 2:23 PM, loudthink wrote:

Porque evidentemente es un foco de confusiones y errores.
Normalmente o bien esta documentado en la descripcion, o bien se
deduce de los ejemplos, o se usa un convenio para los nombres: Por
ejemplo options, html_options, object, name, text_field_tag,
build_association, User#posts (que se entiende que devuelve objetos
Post y no objetos Comment sin necesidad de explicitarlo), etc. La
documentacion en linea es mi principal referencia y trabajo bien con
ella. Para complementar a esa referencia uso diversos libros, el
Agile, el Pickaxe, el booklet de RJSs, etc. pero no para averiguar el
tipo de los objetos.

Piensa que hay montones de personas desarrollando con el mismo
material. La documentacion en linea de Rails en terminos generales es
mejorable, cualquiera que desarrolle mas o menos ha de pasar por un
libro. Pero la API en si creo que no esta mal, y a la practica creo
que no es tal foco de confusion.

– fxn