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

Docstrings need to embed parameters in backticks

Aperta
#72 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
julia
Ambito
documentation

Direzione di ricerca

Inizia individuando il codice che genera i docstring per i parametri OpenAPI e riproduci il rendering markdown mostrato nell’issue. Verifica come vengono emessi i nomi dei parametri contenenti underscore; il lavoro è completato quando tali nomi vengono sottoposti a rendering letterale nella documentazione generata, senza che markdown li analizzi.

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

Descrizione

stale

Otherwise, underscores get parsed as markdown, leading to:

Screenshot 2024-04-14 at 9 23 19 PM
Lingua principale
Julia
Stelle
56
Fork
16
Merge medio
1g 51m
PR unite (30g)
12

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 JuliaComputing/OpenAPI.jl

Tutte le issue di JuliaComputing/OpenAPI.jl

Issue simili

Altre issue su Julia

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.