azure-sdk-for-cpp icon indicating copy to clipboard operation
azure-sdk-for-cpp copied to clipboard

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

Open antkmsft opened this issue 2 years ago • 1 comments

@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 https://github.com/Azure/azure-sdk-for-cpp/pull/4656#discussion_r1207173550"

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

antkmsft avatar May 30 '23 18:05 antkmsft

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

LarryOsterman avatar May 30 '23 18:05 LarryOsterman

Hi @antkmsft, we deeply appreciate your input into this project. Regrettably, this issue has remained unresolved for over 2 years and inactive for 30 days, leading us to the decision to close it. We've implemented this policy to maintain the relevance of our issue queue and facilitate easier navigation for new contributors. If you still believe this topic requires attention, please feel free to create a new issue, referencing this one. Thank you for your understanding and ongoing support.

github-actions[bot] avatar May 30 '25 18:05 github-actions[bot]