Skip to content
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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

matthewhilton
Copy link

@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit f03bc53
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/6629f17576d0c50008a84727
😎 Deploy Preview https://deploy-preview-751--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@matthewhilton matthewhilton force-pushed the mdl67878-docs branch 2 times, most recently from ef6af6e to 53cd824 Compare September 26, 2023 00:48
@github-actions
Copy link
Contributor

github-actions bot commented Sep 26, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 80 🟠 87 🟢 100 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 60 🟠 85 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 79 🟠 87 🟢 100 🟢 90 🟢 100 Report
/general/releases 🟠 67 🟠 87 🟢 100 🟢 100 🟢 100 Report

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()));
Copy link
Member

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:

Suggested change
$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.

New features as part of MDL-67898
@sarjona
Copy link
Member

sarjona commented Apr 25, 2024

Hi @matthewhilton!
I tried to update the patch with Andrew's proposal but then I realised there are some conflicts with the changes that were integrated in #939 a few weeks ago.

It would be great if you could rebase your patch or close it (whatever works better for you) ;-)
Thanks a lot for your help! :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants