[docs] Error in [Writing a new service]
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What is the URL of the page?
https://moodledev.io/docs/4.1/apis/subsystems/external/writing-a-service
What is the issue with this page?
I'm working with moodle version 4.1.5 and i was making a new external service but in the docs show how create a new Web Service using namespaces and in the section "Write the external function descriptions" you are still using the require_once for the externallib.php file, and if we try to use it, doesn't work.
By the way i love the new moodle devdocs ❤️
Are you able to provide a patch for this?
Yes - I will create one
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.
Research direction
Open the Writing a new service page at the URL and go to the “Write the external function descriptions” section. Compare its require_once guidance with the namespaced approach described elsewhere on the page for Moodle 4.1.5. Done means the section no longer recommends the non-working require_once usage and the documented service example is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100