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

The examples for the API needs a common way to represent the results

Aperta
  • Qualcosa non va?
#705 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
fsharp
Ambito
documentation

Direzione di ricerca

Inizia con l’esempio della documentazione di Option.fold in src/fsharp/FSharp.Core/option.fsi e confronta il relativo commento del risultato inline con le forme proposte resulttoright e resultbelow. Poi traccia il modo in cui FSharp.Formatting esegue il rendering degli esempi di codice; il lavoro è completato quando le due forme del risultato producono un output leggibile sia per i risultati su una sola riga sia per quelli su più righe.

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

Descrizione

enhancement

Taking Option.fold documentation example
as an example you will notice that the output of the example is embedded as a code comment

There are cases where the sample together with the result are long enough to not make sense to be on the same line.

I am proposing 2 custom tags to be used inside the <code> tag:

  • resulttoright (the purpose is to show a nice box with [ Evaluates: ][ "some result here" ])
  • resultbelow (the purpose is to show a box underneath the code block 
           [ Evaluates: ]
       [ "some 
           multiline | or just on line
           result" ])

As a way to have a visual cue use the edit issue in github, and imagine that the textarea is representing the code and the "status bar" with Attach files by dragging ... represents the resultbelow

Lingua principale
F#
Stelle
492
Fork
160
Merge medio
1g 15h
PR unite (30g)
26

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 fsprojects/FSharp.Formatting

Tutte le issue di fsprojects/FSharp.Formatting

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.