FSharp docs expose pre-release functionality
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- fsharp
- Domaine
- documentation
Piste de recherche
Commencez par .github/workflows/docs.yml à la ligne 29 et déterminez quelle version de FSharp.Core et de .NET cible le build de la documentation. Vérifiez comment la documentation générée expose des API telles que Keys et établissez si les fonctionnalités en pre-release sont intentionnelles. Le travail sera considéré comme terminé lorsque la version prise en charge sera claire et que les API en pre-release seront soit exclues, soit clairement identifiées.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Aucune donnée de langage
- Étoiles
- 37
- Forks
- 20
- Merge moyen
- 3 min
- PR mergées (30 j)
- 1
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de fsharp/fsharp-core-docs
-
Missing namespaces?Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
fsharp/fsharp-core-docs#104 · 6 commentaires ·
-
Build doesn't work on Linux?Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
fsharp/fsharp-core-docs#103 · 4 commentaires ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 38/100
fsharp/fsharp-core-docs#82 ·
-
Move to docs.fsharp.org?Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
fsharp/fsharp-core-docs#76 · 4 commentaires · 9 réactions ·
-
fsdocs
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
fsharp/fsharp-core-docs#65 · 5 commentaires ·
Toutes les issues de fsharp/fsharp-core-docs
Issues similaires
-
documentation
Difficulté 1/5 Moins d'une heure Accessibilité débutants 86/100
bridgetownrb/bridgetown#1130 ·
-
Add TOC to repoOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
netlify/netlify-mcp#75 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 91/100
twbs/bootstrap#43050 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
docs(prompt): filer socket fragment hardcodes an issue-intent cap of 8 that Chore runs overrideOuverteagent-butler-finding chore
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
jordansmall/spindrift#5128 ·
Les mainteneurs répondent en général sous 1 jour