Skip to content

Replacing with "opaque box" - #19372

Merged
tdykstra merged 2 commits into
dotnet:masterfrom
marktab:patch-1
Sep 2, 2020
Merged

tdykstra merged 2 commits into
dotnet:masterfrom
marktab:patch-1

Conversation

@marktab

@marktab marktab commented Jul 8, 2020

Copy link
Copy Markdown
Contributor

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)

@marktab
marktab requested a review from a team as a code owner July 8, 2020 19:05
@dotnet-bot dotnet-bot added this to the July 2020 milestone Jul 8, 2020
Comment thread docs/core/rid-catalog.md Outdated
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@adegeo Do you know what this means by "opaque string" and what it means to "treat a RID as a black box"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sent message to PM

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

-- This is an identification format that is not intended to be parsed to retrieve the component parts.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.
??

@adegeo adegeo added the waiting-on-feedback Waiting for feedback from SMEs before they can be merged label Aug 17, 2020
@BillWagner BillWagner modified the milestones: July 2020, September 2020 Sep 1, 2020
@BillWagner

Copy link
Copy Markdown
Member

@tdykstra @adegeo @KathleenDollard Do we have a resolution here?

Comment thread docs/core/rid-catalog.md Resolved
suggestion from tdykstra

Co-authored-by: Tom Dykstra <tdykstra@microsoft.com>
@tdykstra
tdykstra merged commit 156793b into dotnet:master Sep 2, 2020
@marktab
marktab deleted the patch-1 branch September 21, 2020 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-feedback Waiting for feedback from SMEs before they can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

⌂ Proxy