docs: fix enum guidance typo#584
Open
Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Open
Conversation
There was a problem hiding this comment.
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.
| ``` | ||
|
|
||
| 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: |
There was a problem hiding this comment.
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: |
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.
Summary
Related issue
Guideline alignment
CONTRIBUTING.mddocumentation guidance and targets thevNextbranchValidation
git -c core.whitespace=cr-at-eol diff --check