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

📝 Fix minor inconsistencies and typos in tutorial #1067

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

tvoirand
Copy link
Contributor

I think I saw a couple of typos or inconsistencies in the tutorial:

  • Grammar error in commands/one-or-multiple.md
  • Wrong command listed in command/options.md
  • What looks to be missing words in first-steps.md (I doubt a typer "parameter" or "argument" refers to a python function)

Thanks a lot for your work on this great tool. I hope this helps!

@github-actions github-actions bot added the docs Improvements or additions to documentation label Nov 29, 2024
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.

All three are a nice catch, thanks! Looks good to merge.

@tvoirand
Copy link
Contributor Author

Thanks for your feedback.

Oops sorry, I realize I had not updated the python files associated with the code block impacted by my update in commands/one-or-multiple.md. I just corrected this with my second commit.

(I had not thoroughly read and applied the contributing guide that describes this link between docs and python files/tests. That should teach me!)

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.

Right, good catch!

Copy link
Member

@tiangolo tiangolo left a comment

Choose a reason for hiding this comment

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

Great, thanks! 🚀 🔍

@tiangolo tiangolo changed the title Fix minor inconsistencies in tutorial 📝 Fix minor inconsistencies and typos in tutorial Dec 4, 2024
@tiangolo tiangolo merged commit dbc335b into fastapi:master Dec 4, 2024
23 checks passed
@tvoirand tvoirand deleted the tutorial-wording branch December 4, 2024 17:36
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants