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

Discuss member panels

Aperta
#50 10 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
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
fsharp
Ambito
documentation

Direzione di ricerca

Inizia esaminando la generazione di member-panel di FSharp.Formatting nel contesto dei commenti XML di FSharp.Core qui referenziati. Confronta le descrizioni proposte combinate di tipi e parametri, le pagine per membro, il layout verticale e gli elenchi contenenti solo i riepiloghi con gli esempi di PyTorch; il lavoro sarà considerato completato quando sarà stata raggiunta e documentata una decisione definitiva di progettazione.

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

Descrizione

fsdocs

Hi all,

I'd like to discuss the member panels (and the documentation for members more generally) coming out of FSharp.Formatting. I think it's good to do this in the context of FSharp.Core where we have relatively populated XML comments, though it's a more general FSharp.Formatting issue

For FSharp.Core a typical member panel looks like this:

image

Now, the things I'd like some help with are

  1. Should the parameter types and the parameter descriptions be merged together? The F#F codebase is now getting to a point where it's cleaned up enough (and I understand it well enough) to allow this to happen. But what visuals do we want? Are there any really nice docs elsewhere integrating type information and documentation you can point me to?

  2. Do we actually need to move to generating one page per member, especially when example usage starts being added? A library like PyTorch doesn't do this but of course MSDN does.

  3. The left-right display of the member usage feels like wasted space. Perhaps each member should be stacked.

Here's an example of PyTorch (not necesarily great documentation though nor exemplar for FSHarp.Core)

Member list:

image

Member page:

image

The things I notice are:

  • one page for each member

  • vertical stacking

  • types go in italics , parenthesized

  • only summary text on member list page

Lingua principale
Nessun dato sulla lingua
Stelle
37
Fork
20
Merge medio
5m
PR unite (30g)
2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 fsharp/fsharp-core-docs

Tutte le issue di fsharp/fsharp-core-docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.