Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

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

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

Conversation

@chris-allnutt
Copy link
Contributor

Removed duplicate examples word in body documentation

resolves#1296

- remove duplicate of examples text
@codecov
Copy link

codecovbot commentedApr 22, 2020
edited
Loading

Codecov Report

Merging#1299 intomaster willnot change coverage.
The diff coverage isn/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 FilesCoverage Δ
fastapi/applications.py100.00% <0.00%> (ø)
...orial/test_conditional_openapi/test_tutorial001.py100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update4e77737...255e037. Read thecomment docs.

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
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 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?

Copy link
ContributorAuthor

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?

Copy link
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
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
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 ! ☕

@tiangolotiangolo merged commitb79e002 intofastapi:masterMay 17, 2020
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

1 more reviewer

@chenlchenlchenl left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Typo in [EN] tutorial: body-fields

3 participants

@chris-allnutt@tiangolo@chenl

Comments


[8]ページ先頭

©2009-2026 Movatter.jp