Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fixed Typo in [EN] tutorial: body-fields#1299

Merged
tiangolo merged 2 commits into
fastapi:masterfrom
chris-allnutt:fix-typo-in-body-fields
May 17, 2020
Merged

Fixed Typo in [EN] tutorial: body-fields#1299
tiangolo merged 2 commits into
fastapi:masterfrom
chris-allnutt:fix-typo-in-body-fields

Conversation

@chris-allnutt

Copy link
Copy Markdown
Contributor

Removed duplicate examples word in body documentation

resolves #1296

- remove duplicate of examples text
@codecov

codecov Bot commented Apr 22, 2020

Copy link
Copy Markdown

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #1299   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          226       227    +1     
  Lines         6785      6805   +20     
=========================================
+ Hits          6785      6805   +20     
Impacted Files Coverage Δ
fastapi/applications.py 100.00% <0.00%> (ø)
...orial/test_conditional_openapi/test_tutorial001.py 100.00% <0.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 4e77737...255e037. Read the comment docs.

Comment thread docs/en/docs/tutorial/body-fields.md Outdated
You can declare extra information in `Field`, `Query`, `Body`, etc. And it will be included in the generated JSON Schema.

You will learn more about it later to declare examples examples.
You will learn more about it later to declare examples.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does the new sentence make sense to you? If it is only a matter of duplicate examples , should this be:

You will learn more about declaring examples later.

Was that the original meaning of this sentence? Shouldn't it have been a link to somewhere?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm still new to fastapi. I think your wording is definitely clearer, IF we were to add a link it would probably go here https://fastapi.tiangolo.com/tutorial/schema-extra-example/#field-additional-arguments However I can't find any current examples of in document linkage and would prefer not to add something that would break. So I'm thinking the way forward is just to use your wording. Thoughts?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since I was unsure of the original intent of the text, and I also am unsure of where this should link to and what is the proper syntax for such a link, I created an issue and not a PR.

I think it is better to get an authoritative answer for this issue than take a guess that might not be correct.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

BTW, see an example for an internal link in:

https://github.com/tiangolo/fastapi/blob/master/docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md#dependencies-for-a-group-of-path-operations:

[Bigger Applications - Multiple Files](../../tutorial/bigger-applications.md){.internal-link target=_blank}

@tiangolo

Copy link
Copy Markdown
Member

Thanks! I updated it a bit to try and clarify what was the original intention for the meaning of the phrase.

Thanks for your contribution @chris-allnutt ! 🚀 🍰

And thanks for the review @chenl ! ☕

@tiangolo tiangolo merged commit b79e002 into fastapi:master May 17, 2020
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.

Typo in [EN] tutorial: body-fields

3 participants