Doc warnings
未关闭
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 32/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- fsharp
调研方向
首先检查 fsharp/service/service.fsi、fsharp/absil/il.fsi、fsharp/service/ServiceLexing.fsi 和 fsharp/XmlDoc.fsi 中的警告。运行文档构建，以确定哪些警告是文档不完整导致的，哪些警告可能表明 fsdocs 存在 bug。完成的标准是减少报告的警告，并识别出剩余的工具相关警告。
由索引模型根据 Issue 内容生成。
描述
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'
- 主要语言
- F#
- 星标
- 280
- 派生
- 124
- 平均合并
- 4 小时 48 分钟
- 30 天内合并 PR
- 6
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
fsharp/fsharp-compiler-docs 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 50/100
fsharp/fsharp-compiler-docs#983 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
fsharp/fsharp-compiler-docs#968 ·
查看 fsharp/fsharp-compiler-docs 的全部 Issue
相似的 Issue
-
module-request
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
Complexity: Small P-Feature: Projects page ready for merge team role: back end/devOps role: front end size: 0.25pt
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 67/100
bellingcat/toolkit#905 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
blinklabs-io/gouroboros#2577 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复