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

Review and move cspell exceptions closer to the files where they are applied via comments #4668

Open
antkmsft opened this issue May 30, 2023 · 1 comment
Assignees
Labels
Azure.Core bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library.
Milestone

Comments

@antkmsft
Copy link
Member

@LarryOsterman: "Does it make sense to put these into the changelog directly? That way we don't have to constantly update the cspell.json file for every contributor.

Something like is done for the readme file in attestation?

<!-- cspell:words opentelemetry -->

Originally posted by @LarryOsterman in #4656 (comment)"

@antkmsft: "I like the idea of moving cspell exceptions closer to the places where they are applied. For code, that should be a safe way to go.
But in this case, I am not sure if automation that compiles release notes is going to handle the comment correctly.
Let me to complete this PR as it is, and I will open an issue to review and move exceptions to the files."

@github-actions github-actions bot added Client This issue points to a problem in the data-plane of the library. needs-team-triage Workflow: This issue needs the team to triage. Storage Storage Service (Queues, Blobs, Files) labels May 30, 2023
@RickWinter RickWinter added bug This issue requires a change to an existing behavior in the product in order to be resolved. Azure.Core and removed needs-team-triage Workflow: This issue needs the team to triage. Storage Storage Service (Queues, Blobs, Files) labels May 30, 2023
@LarryOsterman
Copy link
Member

Originally posted by @LarryOsterman in #4656 (comment)"

@antkmsft: "I like the idea of moving cspell exceptions closer to the places where they are applied. For code, that should be a safe way to go. But in this case, I am not sure if automation that compiles release notes is going to handle the comment correctly. Let me to complete this PR as it is, and I will open an issue to review and move exceptions to the files."

That makes sense. I don't have problems putting words which are likely to be used in multiple files in the global cspell.json but for things like people's names, it make sense to scope them as tightly as reasonable (this is also why there's a cspell.json in amqp and attestation - for terms that are specific to attestation and amqp).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library.
Projects
None yet
Development

No branches or pull requests

3 participants