The Wayback Machine - https://web.archive.org/web/20240526175617/https://github.com/oasis-tcs/sarif-spec/issues/301
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

Editorial issues from Jim Kupsch, part 2 #301

Closed
ghost opened this issue Dec 18, 2018 · 2 comments
Closed

Editorial issues from Jim Kupsch, part 2 #301

ghost opened this issue Dec 18, 2018 · 2 comments
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. impact-documentation-only non-substantive Change falls under editorial discretion resolved-fixed

Comments

@ghost
Copy link

ghost commented Dec 18, 2018

This issue addresses the second batch from a set of editorial changes proposed by Jim Kupsch (@kupsch).

The first batch is documented in #277.

For the editorial changes I accept, I will make them directly in the CSD.2 provisional draft. For visibility, I will also make them in a change draft Documents\ChangeDrafts\Accepted\sarif-v2.0-editorial-kupsch-2.docx. I will check off each item when it's done.

For the editorial changes I decide not to make, I will list them at the bottom of this issue.

@ghost ghost added impact-documentation-only 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. non-substantive Change falls under editorial discretion labels Dec 18, 2018
@ghost ghost self-assigned this Dec 18, 2018
@ghost
Copy link
Author

ghost commented Dec 18, 2018

Changes I made

Section Change Comment
搂1.2 In the definition of "line," mention that it's 1-based I added a new definition line (number) for that, and said that it can be abbreviated to "line" when there's no ambiguity with its meaning as "a sequence of characters". I also changed the term column to column (number). There's no need for a separate definition of column since we never use that term to mean "a sequence of characters at the same offset from the start of their lines".
搂3.3.2.1 Do not know what "preserve relevant detail that permit the target file to be retrieved from the VCS." means. Changed to: "its value SHALL include sufficient information (for example, a commit id) to enable the correct version of the target file to be retrieved from the VCS"

Changes I did not make

Section Change Comment
Consider "unqualified logical name" for a logical name that is not full qualified I looked at every occurrence of "logical name" in the spec (there are 19) and I think the text is clear and unambiguous as is.
搂3.9.4 Advice on viewers for missing argument A SARIF file with such a mismatch is invalid. The spec says: "The arguments array SHALL contain as many elements as required by the maximum placeholder index among all the message strings specified by the text, richText, messageId, or richMessageId properties." The spec doesn't advise consumers how to handle an invalid file. It's the moral equivalent of "undefined behavior".

@ghost ghost added the resolved-fixed label Apr 1, 2019
@ghost
Copy link
Author

ghost commented Apr 1, 2019

@kupsch I'd never merged these changes from the change draft into the provisional draft. That's done now, so closing.

I still have notes on some additional editorial changes you suggested (notably use of initial capital letter in object names to distinguish from property names), but between this issue and #277 I've addressed the bulk of them.

@ghost ghost closed this as completed Apr 1, 2019
ghost pushed a commit that referenced this issue Apr 1, 2019
ghost pushed a commit that referenced this issue Apr 1, 2019
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-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. impact-documentation-only non-substantive Change falls under editorial discretion resolved-fixed
Projects
None yet
Development

No branches or pull requests

0 participants