fsharp / fsharp/fsharp-core-docs

Query docs for custom operators don't mention they are custom operators

未關閉
#55 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
沒有語言資料
星號
37
分支
20
平均合併
6 分鐘
30 天內合併 PR
1

描述

The [query docs for each custom operator](https://fsharp.github.io/fsharp-core-docs/reference/fsharp-linq-querybuilder.html) need a `remarks` section (or a mention in the summary) about how the custom opreator is used

At the moment there's no mention of the custom operator, and the usage text looks like a method call.

Two sides to this

* partly an FSharp.Core.xml problem (doc comment needs to mention this)

* partly an F#F problem (adjust usage text to show both method call and builder syntax)

![image](https://user-images.githubusercontent.com/7204669/89486136-3f96bc00-d79a-11ea-87c3-a76f45281cac.png)

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

先查看 issue 中連結的查詢文件和相關的 FSharp.Core.xml 文件註解,然後檢查 FSharp.Formatting 如何產生用法文字。更新文件,使每個自訂運算子都獲得識別,且其用法同時顯示方法呼叫語法和建構器語法;產生的查詢文件反映這兩種形式時即完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
fsharp
領域
documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。