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

馃摑 Add misc dependency installs to tutorial docs #2126

Merged

Conversation

TeoZosa
Copy link
Contributor

@TeoZosa TeoZosa commented Oct 3, 2020

Overview

Just some small (potential) improvements to the tutorial, adding required dependency installations that are otherwise not mentioned in their corresponding tutorial sections.

Reasoning:

Although:

  • They are mentioned (with the exception of SQLAlchemy) in the documentation home page (docs/index.md) under the section "Optional Dependencies"
  • The tutorial home page (docs/tutorial/index.md) recommends installing FastAPI with all the optional dependencies and features (i.e., pip install fastapi[all])
  • Corresponding error messages make it fairly obvious as to what dependencies are missing and need to be installed

These additions may still be helpful for beginners and seem to be in keeping with the style of the documentation as a whole (i.e., standalone sections).

@codecov
Copy link

codecov bot commented Oct 3, 2020

Codecov Report

Merging #2126 (307c183) into master (38802ee) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master     #2126   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          532       532           
  Lines        13684     13684           
=========================================
  Hits         13684     13684           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2020

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

Given its relative centrality to this topic of the tutorial, took
style cues from other tutorial docs with similar circumstances (e.g.,
`testing.md`, `static-files.md`, etc.) and added as a standalone
installation section.
@TeoZosa TeoZosa force-pushed the add-misc-dependency-installs-to-tutorial-docs branch from becbb8b to 8247ff6 Compare October 3, 2020 21:30
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2020

馃摑 Docs preview for commit 8247ff6 at: https://5f78f79083304e04f9f8944d--fastapi.netlify.app

@armancswork
Copy link

I think you can add one more, to fix #2134

Given its relative centrality to this topic of the tutorial, took
style cues from other tutorial docs with similar circumstances (e.g.,
`testing.md`, `static-files.md`, etc.) and added as a standalone
installation section.

Closes tiangolo#2134
@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2020

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

@tiangolo tiangolo changed the title Add misc. dependency installs to tutorial docs 馃摑 Add misc dependency installs to tutorial docs Aug 18, 2022
@tiangolo
Copy link
Owner

Thanks for the contribution @TeoZosa! 馃帀

@tiangolo tiangolo enabled auto-merge (squash) August 18, 2022 20:11
@github-actions
Copy link
Contributor

馃摑 Docs preview for commit 307c183 at: https://62fe9cd86ec0de14f818275e--fastapi.netlify.app

@tiangolo tiangolo merged commit ea017c9 into tiangolo:master Aug 18, 2022
JeanArhancet pushed a commit to JeanArhancet/fastapi that referenced this pull request Aug 20, 2022
Co-authored-by: Sebasti谩n Ram铆rez <tiangolo@gmail.com>
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

6 participants