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

📝 Update package docs with the latest versions of Typer and Poetry #781

Merged
merged 8 commits into from
Aug 24, 2024

Conversation

kinuax
Copy link
Contributor

@kinuax kinuax commented Mar 30, 2024

I have followed the package section (Building a Package) and I would propose to update:
-current Poetry dependencies and behavior
-current Typer dependencies and behavior
-current pip behavior
-recent typer command changes
-example user rick harmonization

Copy link

📝 Docs preview for commit 78ff949 at: https://a1c57cae.typertiangolo.pages.dev

Copy link

📝 Docs preview for commit 82b21f9 at: https://44cb1ad4.typertiangolo.pages.dev

@svlandeg svlandeg added docs Improvements or additions to documentation p3 labels Apr 2, 2024
docs/tutorial/package.md Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Apr 7, 2024

📝 Docs preview for commit 19b5663 at: https://1d7e4ec1.typertiangolo.pages.dev

Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

Thanks for this contribution @kinuax! I revised the changes while running through the docs on my system as well, and I can confirm that almost all of your edits accurately reflect the current output and behaviour of poetry and typer. Thanks for going through all of this so carefully!

The only thing that is different on my system and with Typer 0.12.3, are the installed libraries. Could you double check how this looks on your end with the latest Typer? I know there's been some changes in the recent Typer versions, so it's likely that this has changed since you made this PR originally.

docs/tutorial/package.md Outdated Show resolved Hide resolved
docs/tutorial/package.md Show resolved Hide resolved
Copy link

📝 Docs preview for commit ae06c64 at: https://bf13e94e.typertiangolo.pages.dev

Copy link

📝 Docs preview for commit f9d3546 at: https://73a1f39f.typertiangolo.pages.dev

Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

This looks good to me and should be ready for merge after a final review by Tiangolo!

Copy link

github-actions bot commented Aug 9, 2024

@tiangolo tiangolo changed the title 📝 Update package section 📝 Update package docs with the latest versions of Typer and Poetry Aug 24, 2024
@tiangolo
Copy link
Member

Great, thank you @kinuax! 🚀

And thank you @svlandeg for the careful review. 🙇

@tiangolo tiangolo merged commit 1da8e86 into fastapi:master Aug 24, 2024
20 checks passed
@kinuax kinuax deleted the update-package-section branch August 24, 2024 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation p3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants