-
Notifications
You must be signed in to change notification settings - Fork 49
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a clarifying first paragraph to Future.md #623
Conversation
@@ -1,5 +1,7 @@ | |||
# The Future of SARIF | |||
|
|||
The purpose of this document is to list potential new areas for standardization. These are not guarantees. They are areas we are strongly considering for a future edition of the SARIF standard. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "These areas are not guarantees."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is part of what is there. Are you saying replace the whole paragraph and say only this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, I'm saying to add "areas" after using the word "These" so that the reader knows what "These" refers to:
The purpose of this document is to list potential new areas for standardization. These areas are not guarantees. They are areas we are strongly considering for a future edition of the SARIF standard.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, thanks. Yes, that's a good suggestion. I read right past the word "areas" and didn't see it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then I'd be using the word "areas" three times. I'll think of something similar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After thinking about it, the paragraph as a whole seems to work better the way it is, which avoids excessive repetition. If we had that sentence in isolation, then the change would work better.
@Motional-Charles-Wilson , @davidmalcolm : I don't know why github won't let me add you as reviewers, but I'd appreciate it if you would take a look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks, David!
LGTM |
9524caf
to
3a67461
Compare
Thanks for taking a look. I will go ahead and merge now. |
This was requested at the 2024-01-11 meeting.