Example usage missing in docs

未關閉
  • 哪裡不對？
#78 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
1/5
預估耗時
1 小時以內
新手友好度
35/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
停滯
領域
documentation

研究方向

The issue points to the Data.Time module but names no documentation file or test. Read its docs and locate the main data type’s documentation; add a construction example based on the snippet in the issue. Done when the docs show a clear example of constructing a Time value.

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

描述

type: documentation

Even a single example of how to construct the main data type in a module would be really helpful.
For example in Data.Time, you need a lot of understanding and experience to figure out that you're supposed to do something like:

import Data.Enum (toEnum)
myTime2 :: Maybe Time
myTime2 = Time <$> toEnum 11 <*> toEnum 30 <*> toEnum 59 <*> toEnum 213

I didn't have that experience... (Helpful people on #purescript-beginners Slack suggested the above.)
Would you consider adding that kind of example to the docs?

主要語言
PureScript
星號
51
分支
48
平均合併
2 天 23 小時
30 天內合併 PR
1

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 有 Pull Request 範本
  • 沒有貢獻指南

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

purescript/purescript-datetime 的其他 Issue

查看 purescript/purescript-datetime 的全部 Issue

相似的 Issue

更多 Documentation Issue

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

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