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

📝 Remove references to a .rst README generated by poetry new #632

Merged

Conversation

machml
Copy link
Contributor

@machml machml commented Jul 2, 2023

Updated the tutorial doc on packaging Typer CLI tools to reflect current Poetry behaviour.

Currently, the default extension for the README generated by poetry new is .md (not .rst) since this PR.

@machml machml marked this pull request as ready for review July 2, 2023 22:13
@github-actions
Copy link

github-actions bot commented Jul 2, 2023

📝 Docs preview for commit c97b845 at: https://64a1f6c457067b1b9d93f059--typertiangolo.netlify.app

@JacobKochems
Copy link

PR Review Report

according to this guide lines


TL;DR: No code changed. The command poetry new indeed generates a README.md file.


Understand the problem

The docs should be updated to reflect current Poetry behavior.

Check the code

Reproduce the claimed solution
  • No code to be run.
  • No need for a local clone.

Tests

Nothing to test.

Documentation

I looked at the linked docs preview and the formatting/spelling checks out.

@svlandeg svlandeg added docs Improvements or additions to documentation p3 labels Feb 29, 2024
@svlandeg svlandeg changed the title 📝 removed references to a .rst README generated by poetry new 📝 Remove references to a .rst README generated by poetry new Mar 29, 2024
@svlandeg svlandeg marked this pull request as draft March 29, 2024 11:18
Copy link

📝 Docs preview for commit 02ba98d at: https://1731a750.typertiangolo.pages.dev

Copy link

github-actions bot commented Apr 2, 2024

📝 Docs preview for commit b2111ff at: https://4877c586.typertiangolo.pages.dev

Copy link

github-actions bot commented Apr 2, 2024

📝 Docs preview for commit 7fbfad7 at: https://92ac836e.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 the contribution, @jonasmmiguel! I pushed a few updates directly to your branch, but overall this looks good to merge to me 😎

@svlandeg svlandeg marked this pull request as ready for review April 2, 2024 13:49
@tiangolo
Copy link
Member

tiangolo commented Apr 7, 2024

Great, thank you @jonasmmiguel! 🤓

Thanks @JacobKochems for the review with a comment explaining what you checked, that's super helpful! 🍰

Thanks for the review @kinuax. ☕

And thanks @svlandeg for the help as always! 😎 🎉

@tiangolo tiangolo enabled auto-merge (squash) April 7, 2024 04:37
Copy link

github-actions bot commented Apr 7, 2024

📝 Docs preview for commit bbb0d37 at: https://ef2a6b84.typertiangolo.pages.dev

@tiangolo tiangolo merged commit 39fc510 into fastapi:master Apr 7, 2024
15 checks passed
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.

5 participants