moodle / moodle/devdocs

[docs] `rule_overridable` incorrectly included in quizaccess plugin type documentation.

Open Beginner friendly
#1,439 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?

https://moodledev.io/docs/5.0/apis/plugintypes/quizaccess

What is the issue with this page?

This documentation was merged prematurely before the tracker issue that introduced rule_overridable was complete. This has caused some confusion. The API has been refactored during review, meaning the documented version will never be correct. It should be removed, then replaced with a corrected version when MDL-80945 is complete.

Are you able to provide a patch for this?

Yes - I will create one

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 the quizaccess plugin documentation page and locate the rule_overridable entry. Check MDL-80945 for the current API status, then remove the outdated documentation as requested. The work is done when the incorrect rule_overridable reference is no longer present and the page accurately reflects the pending API state.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.