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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Fix code consistency in examples for Tutorial - User Guide - Path Parameters #2158

Merged
merged 4 commits into from
Nov 5, 2020

Conversation

nukopy
Copy link
Contributor

@nukopy nukopy commented Oct 10, 2020

I found typos in the chapter "Path Parameters" in "Tutorial - User Guide".

What

Endpoint's path model in example code should be a plural form, models.

I fixed below:

  • docs_src/path_params/tutoial005.py
  • image associated with this example: docs/en/docs/img/tutorial/image03.png

@Kludex
Copy link
Sponsor Collaborator

Kludex commented Oct 10, 2020

The pipeline is failing because the tests are calling /model instead of /models.

@codecov
Copy link

codecov bot commented Oct 10, 2020

Codecov Report

Merging #2158 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #2158   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          239       239           
  Lines         7079      7079           
=========================================
  Hits          7079      7079           
Impacted Files Coverage 螖
...test_tutorial/test_path_params/test_tutorial005.py 100.00% <酶> (酶)

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 e77ea63...e131337. Read the comment docs.

@nukopy
Copy link
Contributor Author

nukopy commented Oct 10, 2020

Thanks. I fixed tests.

@nukopy nukopy changed the title WIP: Fix typos in docs_src in "Tutorial - User Guide" Fix typos in docs_src in "Tutorial - User Guide" Oct 10, 2020
@github-actions
Copy link
Contributor

馃摑 Docs preview for commit e131337 at: https://5f8224071a19b43513081953--fastapi.netlify.app

@tiangolo tiangolo changed the title Fix typos in docs_src in "Tutorial - User Guide" 馃摑 Fix code consistency in examples for Tutorial - User Guide - Path Parameters Nov 5, 2020
@tiangolo tiangolo merged commit 22a5960 into tiangolo:master Nov 5, 2020
@tiangolo
Copy link
Owner

tiangolo commented Nov 5, 2020

Nice! Good catch, thank you! 馃殌 馃帀

Thanks @Kludex for the help! 馃挭 馃嵃

@nukopy nukopy deleted the fix-typos-in-docs_src branch November 6, 2020 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants