vim-jp / vim-jp/vimdoc-ja-working
[RFC] 記号で囲まれた文字列の前後に空白を入れる/入れないの意識を統一する
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Vim Script
- Stars
- 84
- Forks
- 61
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 35
Description
Vim ドキュメント翻訳者の手引き
https://github.com/vim-jp/vimdoc-ja-working/wiki/Guide
現状では関連するのは以下の記述のみ
"~" や '~' のように引用符でくくられている部分は、くくられている部分を明確にするため、前後に空白を入れる。
`~`と|~|と{~}と<~>については前後に空白は不要である旨の記述を足しませんか?
(実際、空白が入っていない部分が多いように見受けられる)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the Vim documentation translators' Guide at the linked wiki page, starting with the existing rule for quoted text. Add clear guidance for spacing around ~, |~|, {~}, and <~> as proposed, then verify that the guide consistently distinguishes these cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100