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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TPI: FastAPI Tutorial [part 4] #22302

Closed
2 tasks done
luabud opened this issue Oct 24, 2023 · 1 comment
Closed
2 tasks done

TPI: FastAPI Tutorial [part 4] #22302

luabud opened this issue Oct 24, 2023 · 1 comment
Labels
testplan-item Test plan item/assignments for upcoming release
Milestone

Comments

@luabud
Copy link
Member

luabud commented Oct 24, 2023

Refs: #21586

Complexity: 5

Create Issue


We are adding a FastAPI tutorial to our Python docs page (PR). Because it's a fairly large doc to go through, I've broken it down into smaller pieces for the TPIs. You should be able to run through the section defined in this issue without having to read any previous content from the doc, even though a bit of the context might be missing.

Set up:

  1. Create a GitHuib Codespace on the ⚠️ dictionarybased ⚠️ branch of this code sample: https://github.com/microsoft/python-sample-vscode-fastapi-tutorial
  2. Set the following settings in the workspace settings.json:
{
    "python.analysis.typeCheckingMode": "basic",
    "python.analysis.inlayHints.functionReturnTypes": true,
    "python.analysis.inlayHints.variableTypes": true
}

Steps:

  1. Follow the "Replace the database" section in the tutorial-fastapi.md file in this PR: Add FastAPI tutorial to Python docs  vscode-docs#6760

It's probably easier to consume the markdown file here, than in the PR view.

Things we're looking for in this TPI:

  • Ensure the guidance makes sense and is accurate
  • Ensure you get to a successful state at each step
  • Any feedback on wording/structure of this section in the tutorial

You can feel free to open issues with problems you find, or comment in the PR directly.

@luabud luabud added the testplan-item Test plan item/assignments for upcoming release label Oct 24, 2023
@aeschli
Copy link

aeschli commented Oct 24, 2023

Well made tutorial!

@aeschli aeschli removed their assignment Oct 24, 2023
@karthiknadig karthiknadig added this to the October 2023 milestone Oct 24, 2023
@karthiknadig karthiknadig removed their assignment Oct 24, 2023
@luabud luabud closed this as completed Oct 24, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
testplan-item Test plan item/assignments for upcoming release
Projects
None yet
Development

No branches or pull requests

3 participants