fsharp / fsharp/fsharp-compiler-docs
Doc warnings
- Langage dominant
- F#
- Étoiles
- 280
- Forks
- 124
- Merge moyen
- 4 h
- PR mergées (30 j)
- 5
Description
A large number of warnings are generated for incomplete documentation.
Would be good to see the number reduce. Some may also indicate bugs in `fsdocs`
```
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(430,18): warning: missing docs for parameter 'probePoint'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(434,18): warning: missing docs for parameter 'assumeDotNetFramework'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(437,18): warning: missing docs for parameter 'parsingOptions'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(440,18): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(449,18): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(446,18): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\service.fsi(452,18): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\absil\il.fsi(1830,4): warning FD0001: no documentation for 'M:FSharp.Compiler.AbstractIL.IL.mkILReturn(FSharp.Compiler.AbstractIL.IL.ILType)'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\absil\il.fsi(1830,4): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\absil\il.fsi(1913,4): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\absil\il.fsi(1914,4): warning FD0001: no documentation for 'M:FSharp.Compiler.AbstractIL.IL.mkILCustomAttrsFromArray(FSharp.Compiler.AbstractIL.IL.ILAttribute[])'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\absil\il.fsi(1914,4): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\ServiceLexing.fsi(16,6): warning FD0001: no documentation for 'P:FSharp.Compiler.Tokenization.FSharpTokenizerLexState.PosBits'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\ServiceLexing.fsi(17,6): warning FD0001: no documentation for 'P:FSharp.Compiler.Tokenization.FSharpTokenizerLexState.OtherBits'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\ServiceLexing.fsi(21,11): warning FD0001: no documentation for 'M:FSharp.Compiler.Tokenization.FSharpTokenizerLexState.Equals(FSharp.Compiler.Tokenization.FSharpTokenizerLexState)'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\ServiceLexing.fsi(21,11): warning: a parameter was missing a name
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\service\ServiceLexing.fsi(19,18): warning FD0001: no documentation for 'P:FSharp.Compiler.Tokenization.FSharpTokenizerLexState.Initial'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(64,11): warning FD0001: no documentation for 'M:FSharp.Compiler.Xml.PreXmlDoc.ToXmlDoc(System.Boolean,Microsoft.FSharp.Core.FSharpOption{Microsoft.FSharp.Collections.FSharpList{System.String}})'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(64,11): warning: missing docs for parameter 'check'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(64,11): warning: missing docs for parameter 'paramNamesOpt'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(66,11): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.PreXmlDoc.IsEmpty'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(62,18): warning FD0001: no documentation for 'M:FSharp.Compiler.Xml.PreXmlDoc.Create(System.String[],FSharp.Compiler.Text.Range)'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(62,18): warning: missing docs for parameter 'unprocessedLines'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(62,18): warning: missing docs for parameter 'range'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(60,18): warning FD0001: no documentation for 'M:FSharp.Compiler.Xml.PreXmlDoc.Merge(FSharp.Compiler.Xml.PreXmlDoc,FSharp.Compiler.Xml.PreXmlDoc)'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(60,18): warning: missing docs for parameter 'a'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(60,18): warning: missing docs for parameter 'b'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(70,18): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.PreXmlDoc.Empty'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(12,4): warning FD0001: no documentation for 'M:FSharp.Compiler.Xml.XmlDoc.#ctor(System.String[],FSharp.Compiler.Text.Range)'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(12,4): warning: missing docs for parameter 'unprocessedLines'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(12,4): warning: missing docs for parameter 'range'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(26,11): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.XmlDoc.IsEmpty'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(28,11): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.XmlDoc.NonEmpty'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(30,11): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.XmlDoc.Range'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(15,18): warning: missing docs for parameter 'doc1'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(15,18): warning: missing docs for parameter 'doc2'
D:\a\FSharp.Compiler.Service\FSharp.Compiler.Service\fsharp\src\fsharp\XmlDoc.fsi(35,18): warning FD0001: no documentation for 'P:FSharp.Compiler.Xml.XmlDoc.Empty'
```
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par examiner les avertissements dans fsharp/service/service.fsi, fsharp/absil/il.fsi, fsharp/service/ServiceLexing.fsi et fsharp/XmlDoc.fsi. Exécutez la génération de la documentation afin de déterminer quels avertissements concernent une documentation incomplète et lesquels peuvent indiquer des bogues dans fsdocs. Le travail est terminé lorsque les avertissements signalés ont été réduits et que les avertissements restants liés à l’outil ont été identifiés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- fsharp
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 32/100