Skip to content

📝 Change the word "unwrap" to "unpack" in docs/en/docs/tutorial/extra-models.md#13061

Merged
tiangolo merged 5 commits intofastapi:masterfrom
timothy-jeong:fix-doc/tutorial-extra-models
Jan 30, 2025
Merged

📝 Change the word "unwrap" to "unpack" in docs/en/docs/tutorial/extra-models.md#13061
tiangolo merged 5 commits intofastapi:masterfrom
timothy-jeong:fix-doc/tutorial-extra-models

Conversation

@timothy-jeong
Copy link
Contributor

While 'unwrap' (or 'unwrapping') is a Pydantic-specific convention, its usage in the documentation might lead to confusion. The document mentions 'unwrap' with the prefix 'Python', which could incorrectly imply that 'unwrap' is official Python terminology.

The behavior of 'unwrap' described in the tutorial/extra-models document aligns with the "dictionary unpacking" feature in Python dictionary displays (https://docs.python.org/3/reference/expressions.html#dictionary-displays).

Therefore, if the intended behavior is indeed Python's dictionary unpacking, I suggest replacing 'unwrap' with 'unpack' for clarity and consistency with official Python terminology.

While 'unwrap' (or 'unwrapping') is a Pydantic-specific convention, its usage in the documentation might lead to confusion. The document mentions 'unwrap' with the prefix 'Python', which could incorrectly imply that 'unwrap' is official Python terminology.

The behavior of 'unwrap' described in the tutorial/extra-models document aligns with the "dictionary unpacking" feature in Python dictionary displays (https://docs.python.org/3/reference/expressions.html#dictionary-displays).

Therefore, if the intended behavior is indeed Python's dictionary unpacking, I suggest replacing 'unwrap' with 'unpack' for clarity and consistency with official Python terminology.
@github-actions github-actions bot added the docs Documentation about how to use FastAPI label Dec 12, 2024
Copy link
Contributor

@hard-coders hard-coders left a comment

Choose a reason for hiding this comment

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

Sounds reasonable.

timothy-jeong added a commit to timothy-jeong/fastapi that referenced this pull request Dec 12, 2024
다음과 같이 번역하였습니다.
- unwrap -> 언랩(unwrap) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- unwraping -> 언래핑(unwrapping) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- type annotation -> 타입주석(type annotation)
- argument value -> 인자 값(argument value)
timothy-jeong added a commit to timothy-jeong/fastapi that referenced this pull request Dec 12, 2024
다음과 같이 번역하였습니다.
- unwrap -> 언랩(unwrap) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- unwraping -> 언래핑(unwrapping) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- type annotation -> 타입주석(type annotation)
- argument value -> 인자 값(argument value)
@alejsdev alejsdev changed the title Suggest changing the word 'unwrap' to 'unpack' 📝 Suggest changing the word 'unwrap' to 'unpack' Dec 12, 2024
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

Makes sense to me!

@tiangolo tiangolo changed the title 📝 Suggest changing the word 'unwrap' to 'unpack' 📝 Change the word "unwrap" to "unpack" in docs/en/docs/tutorial/extra-models.md Jan 30, 2025
Copy link
Member

@tiangolo tiangolo left a comment

Choose a reason for hiding this comment

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

Makes sense, thanks! ☕

@tiangolo tiangolo merged commit 83ab6ac into fastapi:master Jan 30, 2025
50 checks passed
timothy-jeong added a commit to timothy-jeong/fastapi that referenced this pull request Feb 20, 2025
다음과 같이 번역하였습니다.
- unwrap -> 언랩(unwrap) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- unwraping -> 언래핑(unwrapping) fastapi#13061 의 accept 여부에 따라 번역 변경 예정
- type annotation -> 타입주석(type annotation)
- argument value -> 인자 값(argument value)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation about how to use FastAPI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants