Sto scrivendo un modulo Python che usa Numpy. Sto cercando di seguire il formato di Numpy docstring . In molte delle mie funzioni, vengono visualizzati gli stessi parametri. Sembra ripetitivo spiegare quali sono in più di una funzione dallo stesso modulo. C'è una pratica comune quando si tratta di questo?
Aggiungi una descrizione dettagliata dei parametri alla documentazione della classe o del pacchetto e aggiungi un breve riferimento ad essa dalla documentazione di ogni funzione. Fondamentalmente, mordere il proiettile. Questo non può essere automatizzato o convenientemente migliorato di più.
Leggi altre domande sui tag python documentation python-3.x