micro-editor / micro-editor/micro
Do we need to track duplicated plugin descriptions in `options.md` & `plugins.md`?
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 29.6k
- Forks
- 1.4k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 10
Description
Do we really need to track the same description twice?
https://github.com/zyedidia/micro/blob/838f371486ab3a083cee2471d8ee7f1f33acd595/runtime/help/options.md?plain=1#L471-L481
https://github.com/zyedidia/micro/blob/838f371486ab3a083cee2471d8ee7f1f33acd595/runtime/help/plugins.md?plain=1#L416-L426
I would prefer to track it in one file only and since they are related to plugins the plugins.md would fit the most.
There are already votes against the removal:
I think these should be kept because someone who is autocompleting
setcould try to search for them in options.md to figure out what they mean. It's not immediately obvious (partly due to unfortunate naming of the plugins) that they should be looking at plugins.md instead.
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
Start by comparing the duplicated plugin descriptions in runtime/help/options.md and runtime/help/plugins.md at the linked sections, then read the existing comments about autocomplete discoverability. Done means reaching a decision on the canonical location and updating the documentation so the descriptions are no longer unnecessarily duplicated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100