Replacing with "opaque box" #19372
Replacing with "opaque box" #19372
Conversation
Per https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/b/black-box replacing with "opaque box"
docs/core/rid-catalog.md
Outdated
| @@ -66,7 +66,7 @@ All RIDs eventually map back to the root `any` RID. | |||
|
|
|||
| There are some considerations about RIDs that you have to keep in mind when working with them: | |||
|
|
|||
| - RIDs are **opaque strings** and should be treated as black boxes. | |||
| - RIDs are **opaque strings** and should be treated as opaque boxes. | |||
There was a problem hiding this comment.
@adegeo Do you know what this means by "opaque string" and what it means to "treat a RID as a black box"?
There was a problem hiding this comment.
No idea. @richlander @KathleenDollard
There was a problem hiding this comment.
@tdykstra
Response was that we can choose to hold on the PR for more feedback from PMs or accept the PR and open an issue to define opaque strings. I vote to open a new issue and accept the PR.
There was a problem hiding this comment.
Given that the sentence is meaningless to everyone who has read it so far, I would prefer to modify this PR to remove the line instead of changing the wording.
There was a problem hiding this comment.
-- This is an identification format that is not intended to be parsed to retrieve the component parts.
There was a problem hiding this comment.
Do you mean that a user shouldn't look to a RID to determine platform/os because there isn't a guarntee that the rid is one that identifies that component? Such as using win or osx.10.10-x64 for a rid. The osx one has all the information needed to be parsed, however, the generic win doesn't.
??
|
@tdykstra @adegeo @KathleenDollard Do we have a resolution here? |
suggestion from tdykstra Co-authored-by: Tom Dykstra <tdykstra@microsoft.com>
Per https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/b/black-box replacing with "opaque box"
Summary
Describe your changes here.
Fixes #Issue_Number (if available)