Skip to content

Small doc fix for FastAPI section #253

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.

Sign up for GitHub

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

Jump to bottom
Merged
jxnl merged 1 commit into from
Dec 6, 2023
Merged

Small doc fix for FastAPI section #253

jxnl merged 1 commit into from
Dec 6, 2023

Conversation

@waseemhnyc
Copy link
Contributor

@waseemhnyc waseemhnyc commented Dec 6, 2023 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated the FastAPI guide to reflect the correct import paths for StreamingResponse and included guidance on importing Iterable from the typing module.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 6, 2023 •
edited
Loading

Walkthrough

The recent update in the documentation reflects a minor restructuring in the FastAPI framework, where the StreamingResponse class has been moved from the main fastapi module to a sub-module fastapi.responses. Additionally, there's an introduction of the Iterable type from the typing module, suggesting a refined approach to type annotations within the framework.

Changes

File Path Change Summary
docs/concepts/fastapi.md Moved StreamingResponse import to fastapi.responses and added Iterable import from typing.

🐇✨
To the code that flows like a stream,
A change has come, a subtle gleam.
From fastapi to responses it hops,
With Iterable in tow, our type checks it tops.
🌟🚀

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

@waseemhnyc waseemhnyc changed the title Small doc fix for FastAPI Small doc fix for FastAPI section Dec 6, 2023
coderabbitai[bot]
coderabbitai bot reviewed Dec 6, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between af6543c and bfab5b5.
Files selected for processing (1)
  • docs/concepts/fastapi.md (1 hunks)
Additional comments: 1
docs/concepts/fastapi.md (1)
  • 49-56: The changes to the import statements for StreamingResponse and the addition of Iterable are correctly reflected in the documentation and align with the PR objectives. This update ensures that the documentation is consistent with the current structure of the FastAPI framework.

@jxnl jxnl merged commit ba1070a into 567-labs:main Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] 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.

2 participants

@waseemhnyc @jxnl