📝 Add docstrings to types.py
#6091
Merged
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
Member
Author
|
please review |
Deploying with
|
| Latest commit: |
d20f8f7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6f8c745b.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://kludex-doc-18-types.pydantic-docs2.pages.dev |
lig
suggested changes
Jun 12, 2023
hramezani
reviewed
Jun 12, 2023
hramezani
reviewed
Jun 12, 2023
hramezani
reviewed
Jun 12, 2023
| @classmethod | ||
| def decode(cls, data: bytes) -> bytes: | ||
| """Can throw `PydanticCustomError`.""" | ||
| """Decode the data using the encoder. |
Member
There was a problem hiding this comment.
Decoder?
Suggested change
| """Decode the data using the encoder. | |
| """Decode the data using the decoder. |
Member
Author
There was a problem hiding this comment.
Well, actually, the EncoderProtocol defines how to decode and encode. 🤔
@lig what do you want me to write here?
Contributor
There was a problem hiding this comment.
I'd just left "Decode the data" and "Encode the data" for the opposite method. This is a protocol definition and it's up to user to decide what to use for the implementation.
Member
Author
There was a problem hiding this comment.
If we are not willing to change the EncoderProtocol name, I think it's better if we maintain the "encoder" here. 🤔
Co-authored-by: Hasan Ramezani <hasan.r67@gmail.com>
hramezani
approved these changes
Jun 12, 2023
Member
There was a problem hiding this comment.
Great addition. I left some suggestions.
Other than that LGTM 👍
lig
approved these changes
Jun 12, 2023
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.
Closes DOC-18
Selected Reviewer: @hramezani