Update report builder API docs#1196
Merged
paulholden merged 9 commits intomoodle:mainfrom Dec 6, 2024
Merged
Conversation
The first part seems to be more of an overview of how the report builder API is structured, and how those parts should be used, before talking about how to specifically use it in system reports.
We are also detqailing how to write unit tests for them so that any errors can be found before they go into production
If we do not do this users may see and use features that are not part of the Moodle version they are coding for
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Contributor
Author
|
I think that the issue is that on Windows if you run |
They were being forced to use Windows style slashes and a full path when I ran `yarn lint-staged`
Contributor
⚡️ Lighthouse report for the deploy preview of this PR
|
Member
|
Thanks @NeillM for documenting this - I'll have a look through these |
paulholden
approved these changes
Dec 6, 2024
Contributor
Author
|
Thanks Paul |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I have:
I have attempted to ensure that the docs include API changes that have happened since Moodle 4.3
This change should hopefully implement most of the improvements I think would be useful in Issue #1192