Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.7k
Fixed Typo in [EN] tutorial: body-fields#1299
Conversation
- remove duplicate of examples text
codecovbot commentedApr 22, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ Coverage Diff @@## master #1299 +/- ##========================================= Coverage 100.00% 100.00% ========================================= Files 226 227 +1 Lines 6785 6805 +20 =========================================+ Hits 6785 6805 +20
Continue to review full report at Codecov.
|
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. |
There was a problem hiding this comment.
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 duplicateexamples , 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?
There was a problem hiding this comment.
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 herehttps://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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
[Bigger Applications - Multiple Files](../../tutorial/bigger-applications.md){.internal-link target=_blank}
tiangolo commentedMay 17, 2020
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 ! ☕ |
Removed duplicate examples word in body documentation
resolves#1296