[docs-scanner] Syntax error in backend API code example
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 95/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Open content/manuals/extensions/extensions-sdk/dev/api/backend.md and locate the get method example. Check the snippet's syntax and run any documentation validation available for the repository. Done means the example is valid TypeScript and no longer produces the reported syntax error when copied.
Written by the indexing model from the issue text.
Description
File: content/manuals/extensions/extensions-sdk/dev/api/backend.md
Issue
The code example for the get method has a syntax error - missing closing parenthesis:
ddClient.extension.vm.service .get("/some/service") .then((value: any) => console.log(value)
Why this matters
Readers who copy this code example will get a syntax error. The missing closing parenthesis after console.log(value) makes this invalid TypeScript/JavaScript.
Suggested fix
Add the missing closing parenthesis:
ddClient.extension.vm.service
.get("/some/service")
.then((value: any) => console.log(value))
Found by nightly documentation quality scanner
- Dominant language
- Markdown
- Stars
- 4.7k
- Forks
- 8.5k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 104
Contributor guide
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.
More from docker/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
status/triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
area/dhi status/triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·