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-78282 - [docs] Document sr_text output method #693

Merged
merged 1 commit into from
Aug 25, 2023

Conversation

ferranrecio
Copy link
Collaborator

@ferranrecio ferranrecio commented Jul 26, 2023

Document the new output methods created in MDL-78282

@netlify
Copy link

netlify bot commented Jul 26, 2023

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a162f57
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/64d626c8669eeb000822b91a
😎 Deploy Preview https://deploy-preview-693--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.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 26, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 64 🟠 87 🟢 92 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🔴 38 🟠 85 🟢 92 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 53 🟠 87 🟢 92 🟢 90 🟢 100 Report
/general/releases 🔴 49 🟠 87 🟢 92 🟢 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, Ferran. This looks good in general. A few points:

  • It might be worth adding an example output of the function.
  • Also, perhaps add a description about when it can be used or when it should not be used. E.g. the contents cannot be block elements as it will break HTML validation.

@sarjona sarjona changed the title [docs] Document sr_text output method MDL-78282 - [docs] Document sr_text output method Aug 11, 2023
@ferranrecio
Copy link
Collaborator Author

Hi @junpataleta ,

I amended the commit, adding an output example. However, I don't know in which cases it should not be used. Do we have any guide we can link to?

Copy link
Member

@sarjona sarjona left a comment

Choose a reason for hiding this comment

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

Thanks for working on this, Ferran. The patch looks good and I think it's good enough to have it as it is because it can be improved in the future, if required, to add more information :-)

@sarjona sarjona added this pull request to the merge queue Aug 25, 2023
Merged via the queue into moodle:main with commit b779665 Aug 25, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants