-
Notifications
You must be signed in to change notification settings - Fork 327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] check: add webservice and admin setting docs #751
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
ef6af6e
to
53cd824
Compare
⚡️ Lighthouse report for the deploy preview of this PR
|
docs/apis/subsystems/check/index.md
Outdated
Use the `admin_setting_check` class to easily add these. | ||
|
||
```php title="mod/myplugin/settings.php" | ||
$settings->add(new admin_setting_check('myplugin/usefulcheck', (new \mod\myplugin\check\usefulcheck())->get_ref())); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I strongly recommed wrapping this prematurely early, for example:
$settings->add(new admin_setting_check('myplugin/usefulcheck', (new \mod\myplugin\check\usefulcheck())->get_ref())); | |
$settings->add( | |
new admin_setting_check( | |
'myplugin/usefulcheck', | |
(new \mod\myplugin\check\usefulcheck())->get_ref(), | |
), | |
); |
The reason to do this so early is that we don't know what size window someone will be reading docs in and it's nicer to not have examples wrap because they're in a scrollable div. If things are too wide for that window, it's hard to read the example clearly.
53cd824
to
56198f7
Compare
New features as part of MDL-67898
Hi @matthewhilton! It would be great if you could rebase your patch or close it (whatever works better for you) ;-) |
Related to changes in https://tracker.moodle.org/browse/MDL-67898