Skip to content

📝 Fix minor inconsistencies and typos in tutorial#1067

Merged
tiangolo merged 2 commits intofastapi:masterfrom
tvoirand:tutorial-wording
Dec 4, 2024
Merged

📝 Fix minor inconsistencies and typos in tutorial#1067
tiangolo merged 2 commits intofastapi:masterfrom
tvoirand:tutorial-wording

Conversation

@tvoirand
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
@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