[Gfoss] Documentazione moduli python per qgis

[Luca Mandolesi]

Premetto che non sono un programmatore di professione, nè tantomeno un

>  esperto di python, ma che python sia autodocumentante non ci giurerei...
>
> http://it.diveintopython.org/getting_to_know_python/documenting_functions.html
> Data la sua chiarezza il python è più semplice da comprendere rispetto
> ad altri linguaggi e, a volte, la documentazione nel codice potrebbe
> sembrare superflua, specie a programmatori esperti, mentre per tutti gli
> altri è spesso una necessità. In generale, è sempre consigliabile farlo
> poichè se si riprende il codice a distanza di molto tempo è difficile
> ricordarsi di tutti i passaggi seguiti ed, inoltre, è più semplice così
> riuscire ad isolare un bug partendo da un comportamento inaspettato
> dell'applicazione.


Infatti in Dive into Python è consigliata la documentazione come buona norma
e di solito, anche i neofiti si attengono a tale norma, soprattutto perchè
da un dir() su di una classe o metodo è facile ricavare tutte le funzioni e
dal nome è abbastanza intuibile l'utilizzo; ma dover andare a caso per
capire quanti argomenti e di che tipo devono essere passati diventa un po'
ostico. Tuttavia il fatto che pyQGis è la "traduzione" delle API di Qgis e
nel link che ha postato Antonio (grazie, era questo il passaggio che mi
mancava :) ) http://svn.qgis.org/api_doc/html/classQgsMapCanvas.html ci sono
le doc delle funzioni.

Bene, appena posso inizio a fare qualche traduzione e la posto.

Intanto grazie a tutti!!!

mando
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.faunalia.com/pipermail/gfoss/attachments/20080118/e5b01339/attachment.htm