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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove abbreviated format from docs #451

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Remove abbreviated format from docs #451

merged 2 commits into from
Feb 14, 2024

Conversation

ahouseholder
Copy link
Contributor

This PR removes the "abbreviated format" aka "vector format" from the documentation.

@ahouseholder ahouseholder added this to the SSVC 202403 milestone Feb 12, 2024
@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 12, 2024
@ahouseholder ahouseholder self-assigned this Feb 12, 2024
Copy link
Collaborator

@j--- j--- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure on the best way forward to address the one comment.


The reason a stakeholder might publish something like `U:LESe` is that it expresses that the analyst thought about [*Utility*](#utility) but does not have anything to communicate.
The reason a stakeholder might publish a decision point with more than one value is that it expresses that the analyst thought about [*Utility*](#utility) but does not have anything to communicate.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"more than one value" is not the same as "all values". I think the sentence only makes sense in the context of "all values" ?
Also possible this sentence is just confusing / not something we would recommend people do, so possible option is to remove the whole discussion of the topic, which more broadly is "how to document an analyst looked but didn't learn anything"

That would probably be a separate issue? So the minimum required to just address this translation here is s/more than one value/all values/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

took the easy way out in e01f6a5

I'll spawn a separate issue to revisit the Partial or Incomplete Information section in the future

implement suggested change
@ahouseholder
Copy link
Contributor Author

Leaving a breadcrumb here that there is some additional discussion in #333 about the consequences of this PR.

@j--- j--- merged commit e559355 into main Feb 14, 2024
3 checks passed
@ahouseholder ahouseholder deleted the remove-abbreviated-format branch February 14, 2024 18:59
@ahouseholder ahouseholder modified the milestones: 2024.3, 1Q24 Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reduce emphasis or possibly deprecate the vector format
2 participants