Ruby docs, rails docs => miseria

On 1/29/07, Stefano C. [email protected] wrote:

On Jan 12, 2007, at 10:52 AM, david wrote:

I siti della documentazione sia di Ruby core che di rails fanno
letteralmente cagare. Non ho ancora trovato nessuno che rende le
api
cercabili in maniera decente. E’ il punto più debole sia del

Io vado su http://api.rubyonrails.com/, digito mela-F seguito da (per
esempio) has_many e arrivo sulla documentazione che mi serve. E’
semplice e funzionale. Ancora meglio: mi sono generato la doc sul mio
computer, in modo da consultarla senza andare su Internet.

A parte che la documentazione di Rails non fa cosi’ schifo…

Bravo! Prima di lamentarvi, provate a consultare la doc ufficiale.
Le funzioni pubbliche di rails sono tutte documentate. E in cima al
file dove appaiono, c’è anche una discussione generale sul perché e il
percome delle api di quel file. Secondo me Rails ha avuto una
documentazione di molto buon livello fino dalla prima release che ho
visto.

Posso capire l’obiezione che non c’è sufficiente documentazione di
tipo tutorial. Non so se questa obiezione sia ancora valida, dato che
un po’ di tutorial free esistono. Resta il fatto che puoi comprare il
libro di Thomas e DHH per poche decine di euro. E ci sono sei o sette
altri libri.

A parte che per forza la documentazione di PHP e’ un miliardo di
volte meglio,
deve sopperire al fatto che PHP e’ un miliardo di volte peggio :wink:

Infatti! La doc di PHP è importante soprattutto perché le api di PHP
hanno un comportamento inconsistente da funzione a funzione, e da
release a release. E perché spesso la funzionalità fornita è
incompleta, e alcuni volenterosi forniscono workaround.

Il fatto è che Rails sì, ti vuole rendere la vita semplice, ma assume
che tu sia smart. Per cui DHH non sta a preoccuparsi troppo del
fatto che la sintassi di Ruby sia “strana”. Se non conosci Ruby, sta
a te darti da fare per impararlo. Le risorse ci sono. Stesso
discorso per le (poche) funzioni che non sono documentate. Basta
cliccare su “view source” e si capisce come funzionano. Se ti scoccia
troppo questa cosa, forse Rails non è per te. DHH non ha mai detto
che Rails sia per tutti. Dopo tutto, è codice opinionato.

Chiaro che ci possono essere dei dettagli che comunque non restano
chiari, come ad esempio il dubbio su RAILS_ROOT. Però non è che ci
voglia tanto per aggiungere una mezza paginetta di documentazione sul
wiki di rails. Se nessuno lo fa, vorrà dire che il problema non è
così sentito.

Matteo

Paolo Donà wrote:

Mio primo e ultimo messaggio di questo tipo:
Perchè invece di continuare a fare semi-flame non si comincia a
parlare un pò di codice e di programmazione?

Quoto.

Che ci sia o non ci sia documentazione, è un dato di fatto.
Per qualcuno è carente, per qualcuno è sufficente, ma è abbastanza inutile
stare a conversarne, per giunta senza thé e biscotti, o ci si rimbocca le
mani, oppure cambiamo argomento.

IDL è più che sufficente per flammare =)

Dal canto mio mi sno iscritto qui per avvicinarmi a Ruby, dato che sono
ancora un niubbone, e mi piacerebbe leggere qualcosa più “in topic”, e non
posso far altro che rimettermi a voi, speranzoso.
=D

oooO Oooo
( ) YUS ( )
\ ( Para todos, todo, ) /
_ ) nada para nosotros. ( _/

YUS wrote:

o ci si rimbocca le mani,

Pardon… le maniche.
:stuck_out_tongue:

oooO Oooo
( ) YUS ( )
\ ( Para todos, todo, ) /
_ ) nada para nosotros. ( _/

Mio primo e ultimo messaggio di questo tipo:
Perchè invece di continuare a fare semi-flame non si comincia a parlare un
pò di codice e di programmazione?

Paolo

PS: la domanda è retorica, non voglio risposte, altrimenti si scatena
n’altra catena sul tipo “per me vabene parlare di questo, per me no”

On 1/29/07, YUS [email protected] wrote:

per chi legge le mail via client testuale o sul
[email protected]
http://lists.ruby-it.org/mailman/listinfo/ml


Paolo D.’
SeeSaw | Another point of view

[email protected]
personal http://paolodona.blogspot.com

David W. wrote:

Per esempio, si potrebbe scrivere un piccolissimo esempio
di come usare la funzione, oppure suggerire di spiegare una cosa piuchiaramente (forse illustrando i tuoi dubbi). Per chi sviluppa qualcosa, spesso e molto difficile scrivere documentazione, perche`
sei troppo vicino al progetto per capire cosa vuole sapere la gente, e
come spiegarglielo.

Sono d’accordissimo con te, e conscio dell’importanza della doc, lo
farei
volentieri se ne avessi le capacità, come ho fatto in altri campi (es. PHP
o
localizzazione di Gnome), ma purtroppo al momento ancora non le
possiedo.

Cmq il tuo, per chi saprà coglierlo, è sicuramente uno spunto costruttivo, e
non fine a se stesso come è stato il thread fin’ora.

oooO Oooo
( ) YUS ( )
\ ( Para todos, todo, ) /
_ ) nada para nosotros. ( _/

o ci si rimbocca le
maniche, oppure cambiamo argomento.

E un concetto molto importante nel mondo del software libero. Chiaro, e meglio quando abbiamo le cose che non hanno nemmeno bisogno
di essere migliorate. Pero, se noti un problema, anche se piccolo, sarebbe molto bene fare un patch, o per lo meno descrivere quale e il
problema, dal tuo punto di vista, nel bug tracker del progetto in
questione. Per esempio, si potrebbe scrivere un piccolissimo esempio
di come usare la funzione, oppure suggerire di spiegare una cosa piu chiaramente (forse illustrando i tuoi dubbi). Per chi sviluppa qualcosa, spesso e molto difficile scrivere documentazione, perche`
sei troppo vicino al progetto per capire cosa vuole sapere la gente, e
come spiegarglielo.


David N. Welton

Linux, Open Source Consulting

David W. wrote:

Sono d’accordissimo con te, e conscio dell’importanza della doc, lo
farei volentieri se ne avessi le capacità, come ho fatto in altri
campi (es. PHP o localizzazione di Gnome), ma purtroppo al momento
ancora non le possiedo.

Non e` detto.

Ti ringrazio per la fiducia, ma mi sto davvero avvicinando a Ruby in
questi
giorni, sto ancora studiando su carta (“Ruby per applicazioni web” -
Marco
Ceresa) e facendo indigestione di tutorial, e un sacco di cose basilari
ancora mi sfuggono, tuttavia quando ne avrò modo collaborerò volentieri, al
momento cedo il posto.
=)

oooO Oooo
( ) YUS ( )
\ ( Para todos, todo, ) /
_ ) nada para nosotros. ( _/

Sono d’accordissimo con te, e conscio dell’importanza della doc, lo farei
volentieri se ne avessi le capacità, come ho fatto in altri campi (es. PHP o
localizzazione di Gnome), ma purtroppo al momento ancora non le possiedo.

Non e detto. Come ho scritto, molto spesso chi scrive il programma semplicemente non sa cosa spiegare, e quando scrive la documentazione, non sa se e riuscito a comunicare bene i concetti che lui ormai
prende come ‘naturali’. Avendo scritto il programma, lo conosce
troppo bene per pensare a come sarebbe non conoscerlo.

E quindi anche qualche piccolo suggerimento su cosa aggiungere (o
togliere) in termini di documentazione potrebbe essere utile, se
coloro che gestiscono il progetto sono abbastanza svegli di ascoltare
i nuovi arrivati.


David N. Welton

Linux, Open Source Consulting

Mah… io ieri sono andato sulla doc di ruby “NON RAILS”
e mi sono trovato na pappardelal di classi e metodi ma…
si sono elelcati le classi e metodi ma non c’‘e una riga di spiegazioni
di cosa fa la funzione, ripeto per ora e’ qeullo che e’ spero che in
futuro possano migliorare la doc…

cmq se mi date l’email dei tizi che curano la doc glie spammo un paio de
cose e vediamo cosa mi rispoondono…

On 1/30/07, Alex E. [email protected] wrote:

Mah… io ieri sono andato sulla doc di ruby “NON RAILS”
e mi sono trovato na pappardelal di classi e metodi ma…
si sono elelcati le classi e metodi ma non c’‘e una riga di spiegazioni
di cosa fa la funzione, ripeto per ora e’ qeullo che e’ spero che in
futuro possano migliorare la doc…

Dai un’occhiata a questo:

http://www.ruby-doc.org/docs/ProgrammingRuby/

cmq se mi date l’email dei tizi che curano la doc glie spammo un paio de
cose e vediamo cosa mi rispoondono…

Non credo che sia il caso - e` molto meglio usare il bug tracking
system.


David N. Welton

Linux, Open Source Consulting

_ era quello che cercavo thanks, e’ un po’ incasinato ma mi adattero’
:stuck_out_tongue:

non ha a che fare con la tua domanda ma per chi non lo conoscesse
ancora:

http://facets.rubyforge.org/

ciao

:tele