Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[docs] Error in [Writing a new service]

Open Beginner friendly
#762 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
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
php
Domain
api, documentation

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.

Description

bug documentation help wanted needs-triage
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 ❤️

Screenshot 2023-10-06 154521

Are you able to provide a patch for this?

Yes - I will create one

Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

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.

More from moodle/devdocs

All issues in moodle/devdocs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.