vim-jp / vim-jp/slacklog-generator

テンプレートで利用可能なArgument類をドキュメント書きしるす

Open
#118 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
24
Forks
9
Avg merge
21d 5h
Merged PRs (30d)
1

Description

https://golang.org/pkg/text/template/#hdr-Arguments

いまテンプレートからどんなArgumentや関数が使えるかは go のコードを見るしかない。
これではテンプレートをいじるとき不便なので
列挙&一言レベルで良いのでドキュメントを書いたほうが良い。

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Go code that defines the templates and their available arguments and functions. Use the Go text/template documentation as context, then document each project-provided item with a brief description; done means template users can see the available arguments and functions without reading the Go source.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.