Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✏ Tweak wording in docs/en/docs/advanced/dataclasses.md #3698

Merged
merged 2 commits into from
Sep 4, 2022

Conversation

pfackeldey
Copy link
Contributor

Dear FastAPI developers,

this small PR improves the docs for data classes by adding a missing adjective.

Best, Peter

@tiangolo
Copy link
Member

Thanks for the interest! I'm actually not sure about this. I don't think that "valid" fully conveys the message here, I feel it makes it look like the code is valid or not, but it's not about having the code valid, but the fact that Pydantic has support for it. I would think the word "supported" could work better, but it is also used in the same sentence afterwards.

What do you think?

@pfackeldey
Copy link
Contributor Author

Dear @tiangolo,

yes, I fully agree! I will update the PR with your suggestion asap.

Best, Peter

@github-actions github-actions bot removed the answered label Aug 27, 2022
@codecov
Copy link

codecov bot commented Aug 27, 2022

Codecov Report

Merging #3698 (1963091) into master (25a4828) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff             @@
##            master     #3698     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files          409       535    +126     
  Lines        10244     13825   +3581     
===========================================
+ Hits         10244     13825   +3581     
Impacted Files Coverage Δ
tests/main.py 100.00% <0.00%> (ø)
fastapi/utils.py 100.00% <0.00%> (ø)
fastapi/params.py 100.00% <0.00%> (ø)
fastapi/routing.py 100.00% <0.00%> (ø)
fastapi/encoders.py 100.00% <0.00%> (ø)
tests/test_query.py 100.00% <0.00%> (ø)
fastapi/exceptions.py 100.00% <0.00%> (ø)
fastapi/concurrency.py 100.00% <0.00%> (ø)
fastapi/applications.py 100.00% <0.00%> (ø)
fastapi/openapi/docs.py 100.00% <0.00%> (ø)
... and 158 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link
Contributor

📝 Docs preview for commit 1963091 at: https://6309d9a06d86c24fdc9688f4--fastapi.netlify.app

@tiangolo tiangolo changed the title [docs/dataclasses] add missing valid adjective ✏ Tweak wording in docs/en/docs/advanced/dataclasses.md Sep 4, 2022
@tiangolo
Copy link
Member

tiangolo commented Sep 4, 2022

Cool, thanks @pfackeldey! ☕

@tiangolo tiangolo merged commit f266dc1 into fastapi:master Sep 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants