Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Multiline API documentation

Aperta
#68 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
api, documentation

Direzione di ricerca

La issue non indica alcun file sorgente né alcun test. Inizia esaminando la sintassi attuale di ACT IDL per le descrizioni dei metodi, quindi determina come rappresentare la documentazione in formato elemento multilinea e verifica che la forma scelta venga accettata e preservi l’intero contenuto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Documentation for elements in ACT IDL is currently specified like so:

<method name="Frobricate"
        description="An extremely useful method"/>

Having the description as an attribute makes perfect sense, but when writing an IDL file it makes it very hard to provide comprehensive documentation.

It would be nice, for example, to be able to provide documentation in element form also:

<method name="Frobricate"
        ...>
  <description>

    An extremely useful method.

    This is an implementation of Fred Frobricator's notion of _Frobrication_, introduced in
    the 1867 paper 'On Frobrication', of which you can find a copy here:

        https://www.en.wikipedia.org/wiki/Frobrication

  </description>
</method>

(Also happy with any other solution that allows for documentation in a similar for to my example, be it a different syntax for specifying an attribute of which I am unaware, special comments, or whatever.)

Lingua principale
Go
Stelle
54
Fork
26
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Autodesk/AutomaticComponentToolkit

Tutte le issue di Autodesk/AutomaticComponentToolkit

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.