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

MDL-77353 Functions for generating and displaying user details #634

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

Conversation

tuanngocnguyen
Copy link
Contributor

@tuanngocnguyen tuanngocnguyen commented May 23, 2023

Update doc due to changes in

https://tracker.moodle.org/browse/MDL-77353

@netlify
Copy link

netlify bot commented May 23, 2023

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0936a33
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/646c91a1e3054d000855e6de
😎 Deploy Preview https://deploy-preview-634--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 settings.

@github-actions
Copy link
Contributor

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 46 🟠 87 🟢 100 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 52 🟠 85 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 54 🟠 87 🟢 100 🟢 90 🟢 100 Report
/general/releases 🔴 48 🟠 87 🟢 100 🟢 100 🟢 100 Report

Copy link
Collaborator

@junpataleta junpataleta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @tuanngocnguyen. This needs some more changes before we can merge this to the dev docs. Please see the review comments.

Thanks!


## Functions for generating and displaying user details

#### `core_user::get_profile_picture` for retrieving user picture.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use lists for the methods instead of headings.

Also, something to remember for the future: For accessibility reasons, headings must increase by one level. e.g. an h2 heading needs to have an h3 heading underneath it.

@@ -9,3 +9,9 @@ tags:
import { CodeBlock, CodeExample, InvalidExample, ValidExample } from '@site/src/components';

This page highlights the important changes that are coming in Moodle 4.3 for developers.

## Functions for generating and displaying user details
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A more appropriate heading would be something like "User-related API updates", then followed by a paragraph that describes the update. e.g. "New functions for generating and displaying user details have been created:", then followed by the list of the new user functions.

@sarjona
Copy link
Member

sarjona commented Dec 1, 2023

@tuanngocnguyen apart from the comments raised by Jun, these changes should be moved now to versioned_docs/version-4.3/devupdate.md (because the current docs/devupdate.md is for changes in 4.4 :-) ).

@sarjona sarjona marked this pull request as draft August 19, 2024 05:55
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