docs: use more inclusive language in flask tutorial #707
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I discussed with tutorial with Daniele, who expressed some concerns about the way the tutorial was written. Emphasizing the user doing something ("you do X, then you do Y, ...") gives the impression of a how-to guide. A tutorial is more about doing something together with the user as a learning experience.
Therefore, I changed some of the language from "you" to "we" to frame the experience as more of a tutorial. We're doing this together with the user so that they can learn how to build a rock for a Flask app.
I left some instances of "you" alone where I thought it was appropriate to include.
github-actions
bot
added
the
documentation
lengau
approved these changes
Sep 12, 2024
lengau
changed the title
medubelko
reviewed
Sep 12, 2024
cjdcordeiro
approved these changes
Sep 13, 2024
Co-authored-by: Michael DuBelko <[email protected]>
medubelko
approved these changes
Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I discussed with tutorial with Daniele, who expressed some concerns about the way the tutorial was written. Emphasizing the user doing something ("you do X, then you do Y, ...") gives the impression of a how-to guide. A tutorial is more about doing something together with the user as a learning experience.
Therefore, I changed some of the language from "you" to "we" to frame the experience as more of a tutorial. We're doing this together with the user so that they can learn how to build a rock for a Flask app.
I left some instances of "you" alone where I thought it was appropriate to include.