The Wayback Machine - https://web.archive.org/web/20240531134750/https://github.com/oasis-tcs/sarif-spec/issues/451
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify restrictions on attempting to format plaintext messages. #451

Closed
michaelcfanning opened this issue Feb 17, 2020 · 2 comments
Closed
Labels
2.1.0-candidate-standard-TC-comment Comment submitted by TC member during 60-day OASIS Candidate Standard comment period for SARIF 2.1.0 impact-documentation-only resolved-fixed

Comments

@michaelcfanning
Copy link
Contributor

See 3.11.3 'Plain text messages'

This section clearly states that 'a plain text message SHALL NOT contain formatting information such as HTML tags'. This prohibition also includes more naive attempts to format messages such as using spaces, tabs, etc. to provide indentation or to suggest some structure to the message.

We should add a bit of language that makes it quite explicit: formating s/be restricted to embedded links and the introduction of line end sequences, if necessary, to break apart paragraphs (noting, as we already do, that viewers are free to transform, elide or encode these line end sequences).

Also, a minor point, the text refers to \r as a 'line break' when this character literally refers to a carriage return.

@ghost ghost self-assigned this Feb 21, 2020
@ghost ghost added 2.1.0-candidate-standard-TC-comment Comment submitted by TC member during 60-day OASIS Candidate Standard comment period for SARIF 2.1.0 impact-documentation-only resolved-fixed labels Feb 21, 2020
@ghost
Copy link

ghost commented Feb 21, 2020

Done, except I didn't change the "line break" language. Instead, I changed "line breaks (for example, "\r" or "\n")" to "line breaks (for example, "\r\n" or "\n")"

@ghost ghost closed this as completed Feb 21, 2020
@michaelcfanning
Copy link
Contributor Author

Yes, this seems simpler.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.0-candidate-standard-TC-comment Comment submitted by TC member during 60-day OASIS Candidate Standard comment period for SARIF 2.1.0 impact-documentation-only resolved-fixed
Projects
None yet
Development

No branches or pull requests

1 participant