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

docs: Make the "always save prime numbers" example more clear #1525

Merged
merged 2 commits into from
Jan 9, 2025

Conversation

Tobbe
Copy link
Contributor

@Tobbe Tobbe commented Dec 28, 2024

Description

Update the "Always save cache" example to make it clear that it's talking about prime numbers

Motivation and Context

I was dropped into that docs page without much context from our GitHub actions CI output

Warning: Input 'save-always' has been deprecated with message: save-always does not work as intended and will be removed in a future release.
A separate `actions/cache/restore` step should be used instead.
See https://github.com/actions/cache/tree/main/save#always-save-cache for more details.

And when I just looked at the example it wasn't immediately clear to me what "Primes" was. If it was "primes" as in "This action 'primes' the cache" or if it was "primes" as in "prime numbers".
Reading it through a few times I'm guessing it's the latter; prime numbers. So this PR updates the docs to remove the ambiguity.

How Has This Been Tested?

Not tested

Screenshots (if appropriate):

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (add or update README or docs)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Tobbe Tobbe requested a review from a team as a code owner December 28, 2024 19:37
Copy link
Member

@joshmgross joshmgross left a comment

Choose a reason for hiding this comment

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

Thanks!

I can definitely see the confusion between the verb "primes" and the noun "primes" here.

@joshmgross joshmgross enabled auto-merge (squash) January 9, 2025 23:24
@joshmgross joshmgross merged commit 36f1e14 into actions:main Jan 9, 2025
13 checks passed
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.

2 participants