Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

FSharp docs expose pre-release functionality

Offen
#75 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
fsharp
Bereich
documentation

Rechercherichtung

Beginne mit .github/workflows/docs.yml in Zeile 29 und ermittle, auf welche FSharp.Core- und .NET-Version der Dokumentations-Build abzielt. Prüfe, wie die generierte Dokumentation APIs wie Keys verfügbar macht, und stelle fest, ob Vorabversionsfunktionalität beabsichtigt ist. Als erledigt gilt, dass die unterstützte Version eindeutig ist und Vorabversions-APIs entweder ausgeschlossen oder eindeutig gekennzeichnet sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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
Vorherrschende Sprache
Keine Sprachdaten
Sterne
37
Forks
20
Ø Merge
5 Min.
Gemergte PRs (30 T.)
2

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fsharp/fsharp-core-docs

Alle Issues in fsharp/fsharp-core-docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.