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

Doc warnings

Offen
  • Stimmt etwas nicht?
#967 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
32/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
fsharp
Bereich
documentation

Rechercherichtung

Beginne mit der Überprüfung der Warnungen in fsharp/service/service.fsi, fsharp/absil/il.fsi, fsharp/service/ServiceLexing.fsi und fsharp/XmlDoc.fsi. Führe den Dokumentations-Build aus, um festzustellen, welche Warnungen auf unvollständige Dokumentation hinweisen und welche möglicherweise auf Fehler in fsdocs hindeuten. Als erledigt gilt die Aufgabe, wenn die gemeldeten Warnungen reduziert und alle verbleibenden werkzeugbezogenen Warnungen identifiziert wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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'
Vorherrschende Sprache
F#
Sterne
280
Forks
124
Ø Merge
4 Std. 48 Min.
Gemergte PRs (30 T.)
6

Entwicklungsumgebung

Die Einrichtungsdateien dieses Projekts haben wir noch nicht geprüft. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

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-compiler-docs

Alle Issues in fsharp/fsharp-compiler-docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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