Replace misuses of 'plaintext' with 'cleartext' and clarify spoiler docs #1306
Conversation
Also replaces the term in the documentation of spoilers, where 'spoilered text' makes more sense, in my opinion.
| When sending a spoiler, clients SHOULD provide the fallback in the `body` as shown above | ||
| (including the reason). The fallback SHOULD omit the spoiler text verbatim since `body` | ||
| might show up in text-only clients or in notifications. To prevent spoilers showing up in | ||
| such situations, clients are strongly encouraged to first upload the text containing spoilers | ||
| to the media repository, then reference the MXC URI in a markdown-style link, as shown above. |
There was a problem hiding this comment.
Apologies for the poor diff due to formatting. The real diff is:
When sending a spoiler, clients SHOULD provide the fallback in the
bodyas shown above
(including the reason). The fallback SHOULD omit the spoiler text verbatim sincebody
might show up in text-only clients or in notifications. To prevent spoilers showing up in
such situations, clients are strongly encouraged to first upload the text containing spoilers
to the media repository, then reference the MXC URI in a markdown-style link, as shown above.
There was a problem hiding this comment.
I don't know what "omit the spoiler text verbatim" means, but that's not new.
This looks like a net clarification to me.
There was a problem hiding this comment.
Perhaps we can drop the "verbatim". In any case, it just means: don't include the text containing spoilers in body.
There was a problem hiding this comment.
I've tried to clean this sentence up a bit in c24fb1d.
| When sending a spoiler, clients SHOULD provide the fallback in the `body` as shown above | ||
| (including the reason). The fallback SHOULD omit the spoiler text verbatim since `body` | ||
| might show up in text-only clients or in notifications. To prevent spoilers showing up in | ||
| such situations, clients are strongly encouraged to first upload the text containing spoilers | ||
| to the media repository, then reference the MXC URI in a markdown-style link, as shown above. |
There was a problem hiding this comment.
I don't know what "omit the spoiler text verbatim" means, but that's not new.
This looks like a net clarification to me.
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
anoadragon453
changed the title
Closes #1223.
Also replaces the term in the documentation of spoilers, where 'spoilered text' makes more sense in my opinion.
Preview: https://pr1306--matrix-spec-previews.netlify.app