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

Query docs for custom operators don't mention they are custom operators

Aperta
#55 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
fsharp
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione delle query collegata nell’issue e dai commenti di documentazione pertinenti di FSharp.Core.xml, quindi esamina come FSharp.Formatting genera il testo di utilizzo. Aggiorna la documentazione in modo che ogni operatore personalizzato sia identificato e che il suo utilizzo mostri sia la sintassi di chiamata al metodo sia la sintassi del builder; il lavoro è completato quando la documentazione delle query generata riflette entrambe le forme.

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

Descrizione

The query docs for each custom operator need a remarks section (or a mention in the summary) about how the custom opreator is used

At the moment there's no mention of the custom operator, and the usage text looks like a method call.

Two sides to this

  • partly an FSharp.Core.xml problem (doc comment needs to mention this)

  • partly an F#F problem (adjust usage text to show both method call and builder syntax)

image

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.