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

Improve readability in framework documentation

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione generata del modulo del framework e la relativa configurazione di Scribblings, usando come contesto lo screenshot collegato. Determina come distinguere i confini tra classi o interfacce e i nomi di metodi ripetuti; il lavoro sarà concluso quando la documentazione generata separerà chiaramente ogni tipo e rimarrà facile da cercare.

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

Descrizione

I've been looking forward to step up in my racket journey and start making more complex programs, yet I've been deter from using (most parts of) the framework module because of what appears to be a bug or bad configuration (or most likely a scribblings limitation) in the doc generation.

image
you can (not) see where a class (or interface) ends and where other starts, and since many method names are repeated it gets confusing to search, since everything is flat.

I would like to help, but I wouldn't really now how, I open this issue in hope that this could make the library easier to use.

Lingua principale
Racket
Stelle
68
Fork
83
Merge medio
21h
PR unite (30g)
1

Preparare l'ambiente

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 racket/gui

Tutte le issue di racket/gui

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.