docs: improve OneToOne description #10798
Open
Conversation
This file contains 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
RohanTalip
reviewed
Apr 13, 2024
| @@ -5,17 +5,17 @@ import { RelationOptions } from "../options/RelationOptions" | |||
| import { ObjectUtils } from "../../util/ObjectUtils" | |||
|
|
|||
| /** | |||
| * One-to-one relation allows to create direct relation between two entities. Entity1 have only one Entity2. | |||
| * Entity1 is an owner of the relationship, and storages Entity1 id on its own side. | |||
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. | |||
There was a problem hiding this comment.
Suggested change
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. | |
| * A one-to-one relation allows the creation of a direct relationship between two entities. Entity1 has only one Entity2. |
| */ | ||
| export function OneToOne<T>( | ||
| typeFunctionOrTarget: string | ((type?: any) => ObjectType<T>), | ||
| options?: RelationOptions, | ||
| ): PropertyDecorator | ||
|
|
||
| /** | ||
| * One-to-one relation allows to create direct relation between two entities. Entity1 have only one Entity2. | ||
| * Entity1 is an owner of the relationship, and storages Entity1 id on its own side. | ||
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. |
There was a problem hiding this comment.
Suggested change
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. | |
| * A one-to-one relation allows the creation of a direct relationship between two entities. Entity1 has only one Entity2. |
| @@ -24,8 +24,8 @@ export function OneToOne<T>( | |||
| ): PropertyDecorator | |||
|
|
|||
| /** | |||
| * One-to-one relation allows to create direct relation between two entities. Entity1 have only one Entity2. | |||
| * Entity1 is an owner of the relationship, and storages Entity1 id on its own side. | |||
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. | |||
There was a problem hiding this comment.
Suggested change
| * One-to-one relation allows the creation of a direct relation between two entities. Entity1 has only one Entity2. | |
| * A one-to-one relation allows the creation of a direct relationship between two entities. Entity1 has only one Entity2. |
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.
Description of change
Improved the description of the
OneToOnerelationship and corrected related grammatical errors.Pull-Request Checklist
masterbranchnpm run formatto apply prettier formattingnpm run testpasses with this changeFixes #0000