LuaLS / LuaLS/lua-language-server
How to annotate default arguments to parameters
オープン
まだ誰も着手していません。
- 主要言語
- Lua
- スター
- 4.4k
- フォーク
- 442
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Is there a standard way to annotate default arguments? I believe in LDoc you can do:
-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset
I'm currently converting some docs over and couldn't find anything in the wiki.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
プロジェクトのwikiと既存のアノテーションに関するドキュメントから始め、IssueのLDocの例とサポートされている構文を比較してください。デフォルト引数を表現する標準的な方法をドキュメント化するか、その構文がサポートされていないことを明確にして、ドキュメントを変換するユーザーが正しいアノテーションを判断できるようにしてください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- lua
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100