-
Notifications
You must be signed in to change notification settings - Fork 305
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
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
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.
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.
f3fe243
to
a162f57
Compare
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? |
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.
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 :-)
Document the new output methods created in MDL-78282