🔥 Remove line breaks from param descriptions (#2473)

* 🔥 Remove line breaks from param descriptions

* 🔥 Remove more line breaks

* 🎨 Fix spacing for list item in tooltip

*  Apply multiline with <p> tags

*  Improve <code> and <a> tags

* ✏️ Improve grammar and spelling

*  Add missing <p> tags

* ✏️ Make "multiple" phrasing consistent

*  Fix unneeded quote escapes

*  Encode angle brackets

*  Fix typo and copy-paste artifact
This commit is contained in:
Iván Ovejero
2021-11-25 18:10:06 +01:00
committed by GitHub
parent 260ab395d1
commit 0764c49dcf
120 changed files with 327 additions and 659 deletions

View File

@@ -113,36 +113,21 @@ export const pushFields = [
type: 'string',
default: '',
required: false,
description: `Emails (strings) to whom to send the notification.<br>
If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails'<br>
are not supplied, then everyone who follows the channel will receive the push notification.<br>
If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.<br>
If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.<br>
See the "Followers" section to learn how to list the userIds of those who follow one of your channels.`,
description: `<p>Emails (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the "Followers" section to learn how to list the userIds of those who follow one of your channels.</p>`,
},
{
displayName: 'Push To Followers',
name: 'pushToFollowers',
type: 'string',
default: '',
description: `User IDs (strings) to whom to send the notification.<br>
If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails'<br>
are not supplied, then everyone who follows the channel will receive the push notification.<br>
If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.<br>
If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.<br>
See the "Followers" section to learn how to list the userIds of those who follow one of your channels.`,
description: `<p>User IDs (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the "Followers" section to learn how to list the userIds of those who follow one of your channels.</p>`,
},
{
displayName: 'Push To Phone Numbers',
name: 'pushToPhoneNumbers',
type: 'string',
default: '',
description: `Phone numbers (strings) to whom to send the notification.<br>
If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails'<br>
are not supplied, then everyone who follows the channel will receive the push notification.<br>
If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.<br>
If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.<br>
See the "Followers" section to learn how to list the userIds of those who follow one of your channels.`,
description: `<p>Phone numbers (strings) to whom to send the notification. If all three attributes 'pushToFollowers', 'pushToPhoneNumbers' and 'pushToEmails' are not supplied, then everyone who follows the channel will receive the push notification.</p><p>If 'pushToFollowers' is supplied, only those listed in the array will receive the push notification.</p><p>If one of the userIds supplied does not follow the specified channel, then that userId value will be ignored.</p><p>See the "Followers" section to learn how to list the userIds of those who follow one of your channels.</p>`,
},
{
displayName: 'Schedule',