Skip to content

docs: fix enum guidance typo#584

Open
Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Rohan5commit:docs/fix-enum-guidance-typo-20260427
Open

docs: fix enum guidance typo#584
Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Rohan5commit:docs/fix-enum-guidance-typo-20260427

Conversation

@Rohan5commit
Copy link
Copy Markdown

Summary

  • fix the "appropraite" typo in the enum modeling guidance

Related issue

  • N/A (trivial documentation typo fix)

Guideline alignment

  • follows CONTRIBUTING.md documentation guidance and targets the vNext branch
  • keeps the change to a single documentation sentence with no behavior impact

Validation

  • ran git -c core.whitespace=cr-at-eol diff --check

Copilot AI review requested due to automatic review settings April 27, 2026 02:40
@Rohan5commit Rohan5commit requested a review from a team as a code owner April 27, 2026 02:40
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a typo in the enum modeling guidance documentation under graph/patterns, improving clarity without changing any runtime behavior.

Changes:

  • Corrects the misspelling “appropraite” to “appropriate” in the nullable-enum guidance sentence.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread graph/patterns/enums.md
```

Similarly speaking, if you find yourself using a `nullable` Enum, that is a indication that maybe what you are trying to model is something that has 3 states and an enum is more appropraite. For instance, let's assume we have a boolean property called `syncEnabled`, where `null` means that the value is undefined and inherited from the general tenant configuration. Instead of modelling like a boolean:
Similarly speaking, if you find yourself using a `nullable` Enum, that is a indication that maybe what you are trying to model is something that has 3 states and an enum is more appropriate. For instance, let's assume we have a boolean property called `syncEnabled`, where `null` means that the value is undefined and inherited from the general tenant configuration. Instead of modelling like a boolean:
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

In this sentence there are still a couple of typos/grammar issues: "that is a indication" should be "that is an indication", and "modelling" is inconsistent with the rest of the patterns docs (which use "modeling"). Consider correcting both while you’re here since this line is already being edited.

Suggested change
Similarly speaking, if you find yourself using a `nullable` Enum, that is a indication that maybe what you are trying to model is something that has 3 states and an enum is more appropriate. For instance, let's assume we have a boolean property called `syncEnabled`, where `null` means that the value is undefined and inherited from the general tenant configuration. Instead of modelling like a boolean:
Similarly speaking, if you find yourself using a `nullable` Enum, that is an indication that maybe what you are trying to model is something that has 3 states and an enum is more appropriate. For instance, let's assume we have a boolean property called `syncEnabled`, where `null` means that the value is undefined and inherited from the general tenant configuration. Instead of modeling like a boolean:

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants