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

FSharp docs expose pre-release functionality

Aperta
#75 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia da .github/workflows/docs.yml alla riga 29 e determina quale versione di FSharp.Core e .NET prende di mira la build della documentazione. Verifica in che modo la documentazione generata espone API come Keys e stabilisci se la funzionalità pre-release è intenzionale. Il lavoro sarà considerato completato quando la versione supportata sarà chiara e le API pre-release saranno escluse oppure chiaramente identificate.

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

Descrizione

https://github.com/fsharp/fsharp-core-docs/blob/7d5b8049262e298e6e620ff308ada7999b9a2d81/.github/workflows/docs.yml#L29

My main question is: Is it intentional to have the docs show pre-release functionality?

I was writing a little app and forgot some syntax when using map. I checked the docs and noticed that it exposed a Keys property. I tried to use that instead of what I was doing. After a bit of poking to see if I was somehow missing a namespace I was helped by another engineer who said that Keys is a dotnet 6 feature. I then tried to answer the question "What of this can I use, and what can't I use yet?" which I was unable to do easily.

If this isn't intentional, I could see a number of ways to help:

  • Build the docs not off of main, but off a release branch.
  • Build off the main branch, but leave it to maintainers to mark functionality "pre-release" through an attribute and remove them when the functionality reaches the current dotnet version
  • This would probably be a larger effort, but enhance the docs so they can be contextual based on the dotnet version similar to how the Microsoft docs here work
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.