8000 Add documentation of example kwarg of Field by JohnPaton · Pull Request #1106 · fastapi/fastapi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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

Add documentation of example kwarg of Field #1106

Merged
merged 3 commits into from
Mar 29, 2020

Conversation

JohnPaton
Copy link
Contributor
@JohnPaton JohnPaton commented Mar 11, 2020

Solves #924

I wasn't sure "Providing Examples" warranted its entire own page in the tutorial, but since providing examples was treated treated in "Body - Fields", I just extended that discussion to include the usage of the example keyword argument to Field

Related: #723

@codecov
Copy link
codecov bot commented Mar 11, 2020

Codecov Report

Merging #1106 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #1106   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          223       223           
  Lines         6665      6665           
=========================================
  Hits          6665      6665           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be21b74...4c1b8d1. Read the comment docs.

@JohnPaton JohnPaton changed the title Add documentation of example kwarg of Field [DOC] Add documentation of example kwarg of Field Mar 17, 2020
@tiangolo tiangolo force-pushed the doc-example-improvement branch from 9793c96 to 8d56672 Compare March 29, 2020 19:33
@tiangolo tiangolo merged commit 016a4b7 into fastapi:master Mar 29, 2020
@tiangolo
Copy link
Member

Great! Thanks for your contribution @JohnPaton ! 🚀 🍰

I updated it to explain a bit more about how the example works.

@JohnPaton
Copy link
Contributor Author

Awesome, great context on there, thanks!

@tiangolo tiangolo changed the title [DOC] Add documentation of example kwarg of Field Add documentation of example kwarg of Field Feb 24, 2023
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
0