wrong directory name in plugin example

Open Beginner friendly
#3,553 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
lua
Domain
documentation

Research direction

Open runtime/help/plugins.md at the linked lines and compare the documented plugin directory name with the Lua script naming described in the issue. Update the example so the directory name is correct, then verify that the help text no longer instructs users to use the non-working name.

Written by the indexing model from the issue text.

Description

As far as I can tell, the name of a plugin directory has to match the name of the Lua script: If the script is called myscript.lua, then the directory has to be myscript, not myscript-plugin as indicated in the help file:

https://github.com/zyedidia/micro/blob/56c1f75bad017a817e7ecf7e5b3bb0df7c4a8623/runtime/help/plugins.md?plain=1#L16-L22

With a wrong directory name the plugin won't work.

Dominant language
Go
Stars
29.6k
Forks
1.4k
Avg merge
2d 18h
Merged PRs (30d)
10

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.

More from micro-editor/micro

All issues in micro-editor/micro

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.