fsharp / fsharp/fsharp-compiler-docs
Doc warnings
- Ngôn ngữ chính
- F#
- Star
- 280
- Fork
- 124
- Merge trung bình
- 4 giờ
- Pull request đã merge (30 ngày)
- 5
Mô tả
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'
```
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Hướng nghiên cứu
Bắt đầu bằng việc xem xét các cảnh báo trong fsharp/service/service.fsi, fsharp/absil/il.fsi, fsharp/service/ServiceLexing.fsi và fsharp/XmlDoc.fsi. Chạy bản build tài liệu để xác định cảnh báo nào là do tài liệu chưa đầy đủ và cảnh báo nào có thể cho thấy lỗi trong fsdocs. Công việc được xem là hoàn tất khi đã giảm các cảnh báo được báo cáo và xác định các cảnh báo còn lại liên quan đến công cụ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- fsharp
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 32/100