Fix invalid reference inside Fields/Immutability documentation #7870
Conversation
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
…ain text. As it is already being declared few lines below it.
rnazali
commented
Oct 19, 2023
| @@ -651,7 +651,7 @@ See [Conversion Table](conversion_table.md) for more details on how Pydantic con | |||
|
|
|||
| ## Immutability | |||
|
|
|||
| The parameter `frozen` is used to emulate the [frozen dataclass] behaviour. It is used to prevent the field from being | |||
| The parameter `frozen` is used to emulate the frozen dataclass behaviour. It is used to prevent the field from being | |||
| assigned a new value after the model is created (immutability). | |||
|
|
|||
| See the [frozen dataclass documentation] for more details. | |||
There was a problem hiding this comment.
The correct reference is already mentioned down here.
|
please review |
hramezani
approved these changes
Oct 19, 2023
|
Thanks @rahmatnazali |
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.
Change Summary
On Fields/Immutability Documentation, there is a broken markdown link that supposed to refer to the frozen dataclass documentation.
As the link is already well defined several lines below it, I propose to remove this back to plain text.
Related issue number
None so far.
Checklist
Selected Reviewer: @adriangb