Skip to content

Consistent tutorial language#444

Closed
haampie wants to merge 5 commits into
spack:mainfrom
haampie:consistent-tutorial-language
Closed

Consistent tutorial language#444
haampie wants to merge 5 commits into
spack:mainfrom
haampie:consistent-tutorial-language

Conversation

@haampie

@haampie haampie commented Jun 3, 2025

Copy link
Copy Markdown
Member

we not you

edit: this is a caricature

Replaced instances of "let's do ...", "we will ...", and "the packager can ..."
with "you will ..." or passive voice equivalents across the following tutorial files:
- tutorial_advanced_packaging.rst
- tutorial_basics.rst
- tutorial_binary_cache.rst
- tutorial_buildsystems.rst

This change improves the consistency and clarity of the tutorial documentation.
I replaced instances of "you will", "you can", "you are", "you should", "your", and "let's" with "we will", "we can", "we are", "we should", "our", and "let us" respectively in the following files:
- tutorial_packaging.rst
- tutorial_scripting.rst
- tutorial_stacks.rst

This change makes the language more consistent throughout the tutorials.
I replaced instances of "you will", "you can", "you are", "you should", "your", and "let's" with "we will", "we can", "we are", "we should", "our", and "let us" respectively in the following files:
- tutorial_packaging.rst
- tutorial_scripting.rst
- tutorial_stacks.rst

This change makes the language more consistent throughout the tutorials.
I've updated the following tutorial files to use consistent language:
- tutorial_configuration.rst
- tutorial_developer_workflows.rst
- tutorial_environments.rst
- tutorial_modules.rst

Changes include:
- Replaced "you will" with "we will"
- Replaced "you can" with "we can"
- Replaced "your" with "our" (contextually)
- Replaced "yourself" with "ourselves"
- Replaced "the packager can" with "we can"
- Ensured "let's" and its variants align with the "we will" tone.

These changes should improve the readability and consistency of your tutorial documentation.
I've updated the language in the following tutorial files to use "we will..." and "let's..." consistently, replacing variations like "you will...", "the packager can...", etc.:

- tutorial_advanced_packaging.rst
- tutorial_basics.rst
- tutorial_binary_cache.rst
- tutorial_buildsystems.rst

This change improves the readability and consistency of the tutorials.
@haampie haampie closed this Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant