docs: use neutral vocabulary examples - #37
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates XML documentation examples to use a neutral placeholder name, keeping the public API and runtime behavior unchanged while making docs more generic.
Changes:
- Replaced a specific person-name example with
"Contoso"inAddVocabularyWordAsyncparameter documentation. - Updated
DictionaryEntry.WordandDictionaryEntryType.VocabularyWordXML documentation example lists to remove person-name examples and use"Contoso"instead.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| AirType/Services/Dictionary/IDictionaryManager.cs | Updates the word parameter XML doc examples to use a neutral placeholder. |
| AirType/Models/Dictionary/DictionaryEntry.cs | Updates XML doc examples for vocabulary word entries/types to use a neutral placeholder. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: samonjoat <52766763+samonjoat@users.noreply.github.com>
samonjoat
force-pushed
the
cleanup/public-profile-safety
branch
from
August 3, 2026 21:03
cd1c6fe to
fca5c02
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace specific person-name examples in XML documentation with a neutral placeholder. Runtime behavior is unchanged.