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.

Sign up for GitHub

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

Jump to bottom

chore(plugins/tidy-html): add default to jsdoc param #1298

Merged
merged 1 commit into from
Mar 3, 2023
Merged

chore(plugins/tidy-html): add default to jsdoc param #1298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/plugins/tidy-html/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ async function plugin(server) {
/**
* @param {string} html - Valid HTML.
* @param {object} options - Function config values.
* @param {string=} options.language - Set `lang` and `xml:lang` attributes of `<html>` tag.
* Defaults to `en` if not set.
* @param {string} [options.language="en"] - Set `lang` and `xml:lang` attributes of `<html>` tag.
* @param {boolean=} options.removeAlt - Set `alt` attributes in `<img>` tags to empty string if set to `true`.
* Useful for sending to clinical systems where img tags are stripped from received documents
* (i.e. TPP's SystmOne), and for screen reader users.
Expand Down