moodle / moodle/devdocs

[docs] Error in [pagename]

Open
#1,327 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation help wanted needs-triage
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

What is the URL of the page?
devdocs/docs/apis/plugintypes/tiny/index.md
What is the issue with this page?

Hi,
Thanks for your documentation.
In the documentation of a tiny plugin, with the given content of plugin.js, i raise the error :
error Promise executor functions should not be async no-async-promise-executor

add :
// eslint-disable-next-line no-async-promise-executor
before the line :
export default new Promise(async(resolve) => {
solve the problem for me.
BC

Are you able to provide a patch for this?

None

Contributor guide

Open the contributing guide

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

Open devdocs/docs/apis/plugintypes/tiny/index.md and inspect the plugin.js example around the async Promise executor. Confirm the no-async-promise-executor error, then update the documented example so the reported ESLint error is addressed and verify the snippet is correct.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.