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

Improve Advanced Usage examples #645

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve Advanced Usage examples #645

wants to merge 3 commits into from

Conversation

lrq3000
Copy link

@lrq3000 lrq3000 commented Apr 9, 2023

Description:
A few improvement of Advanced Usage examples:

  • Rework outputs python-version to replace missing words in description and clarify example.
  • Mention '*' for python-version to get the latest stable python release.
  • Mention that if statements need to use single-quotes, not double-quotes (and not no-quotes) to test python-version against string literals.

I tried to keep with the conventions used elsewhere in the document, and for my contributions to be as concise as possible (eg, the if statement is not its own paragraph but is just one additional line in the Matrix Testing example, the most relevant one as it's the most common case scenario for an if testing).

Related issue:
Closes #644.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

Description was lacking words, example was misleading (id was set to cp310 which clearly was a reference to CPython 3.10, but the id is referring to the setup-python action!
@lrq3000 lrq3000 requested a review from a team as a code owner April 9, 2023 20:33
Signed-off-by: Stephen L. <lrq3000@gmail.com>
Signed-off-by: Stephen L. <lrq3000@gmail.com>
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.

Cannot test matrix.python-version in a if statement if version is dynamic (eg, *, 3.12-dev, 3.x)
1 participant