Skip to content

Rewrite readmes#1085

Merged
bishal-pdMSFT merged 2 commits into
actions:mainfrom
jsoref:readme
Jan 31, 2023
Merged

Rewrite readmes#1085
bishal-pdMSFT merged 2 commits into
actions:mainfrom
jsoref:readme

Conversation

@jsoref

@jsoref jsoref commented Jan 22, 2023

Copy link
Copy Markdown
Contributor

Description

Fix various grammatical elements in the readmes

Motivation and Context

The content needed an editor to review it.

How Has This Been Tested?

  • I checked a number of the links (a couple were broken).
  • I fed some of the content to app.grammarly.com

Screenshots (if appropriate):

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.

@jsoref
jsoref requested a review from a team as a code owner January 22, 2023 22:29
@github-actions
github-actions Bot requested a review from t-dedah January 22, 2023 22:29
@lvpx

lvpx commented Jan 23, 2023

Copy link
Copy Markdown
Contributor

Excellent effort on fixing these @jsoref 💯

Comment thread README.md Outdated

### Inputs

* `key` - An explicit key identifying a cache. See [creating a cache key](#creating-a-cache-key).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Technically a key does not identify a cache uniquely which I feel this sentence seems to be indicating. Hence better to go back to older text.

Suggested change
* `key` - An explicit key identifying a cache. See [creating a cache key](#creating-a-cache-key).
* `key` - An explicit key for restoring and saving the cache. See [creating a cache key](#creating-a-cache-key).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Would you accept naming instead of identifying?

I'm trying to:

  • avoid the awkwardness of restoring and saving instead of saving and restoring -- yes, I get that the sequence is restore and then save (although I believe that in practice it will really only restore or save, because if the cache exists to restore, it will not save since caches are write-once by id)
  • harmonize the text across all three files

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've applied this change:

-* `key` - An explicit key identifying a cache. See [creating a cache key](../README.md#creating-a-cache-key).
+* `key` - An explicit key for a cache entry. See [creating a cache key](../README.md#creating-a-cache-key).

Which seems like a more correct entry. It's consistent with the wording in nearby lines, avoids the problem of the restore/save, and avoids using the awkward identifying.

Comment thread examples.md Outdated
- [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods)
- [Swift - Swift Package Manager](#swift---swift-package-manager)
- [Swift - Mint](#swift---mint)
- [Examples](#examples)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This file itself is for examples. Do we really this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This file section an attractive nuisance. I'm pretty sure that VSCode did this on its own.

Comment thread restore/README.md Outdated
Comment thread save/README.md Outdated
@bishal-pdMSFT

Copy link
Copy Markdown

The content needed an editor to review it.

So true :)

Thanks @jsoref for opening this PR and making really good suggestions. I have left a couple comments.

@jsoref

jsoref commented Jan 31, 2023

Copy link
Copy Markdown
Contributor Author

@bishal-pdMSFT: if you're ok w/ the one swap to naming, I'll rebase w/ that change -- (and try to drop the ToC mess...)

Comment thread examples.md
Comment thread README.md Outdated
Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>

@kotewar kotewar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me, thanks for the PR! 👍🏽

@bishal-pdMSFT
bishal-pdMSFT merged commit 22d3da7 into actions:main Jan 31, 2023
@jsoref
jsoref deleted the readme branch January 31, 2023 11:01
dapirian referenced this pull request in trunk-io/plugins Mar 9, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/cache](https://togithub.com/actions/cache) | action | minor |
`v3.2.4` -> `v3.3.0` |
| [github/codeql-action](https://togithub.com/github/codeql-action) |
action | patch | `v2.2.3` -> `v2.2.5` |
| [trunk-io/trunk-action](https://togithub.com/trunk-io/trunk-action) |
action | patch | `v1.0.6` -> `v1.0.7` |

---

### Release Notes

<details>
<summary>actions/cache</summary>

### [`v3.3.0`](https://togithub.com/actions/cache/releases/tag/v3.3.0)

[Compare
Source](https://togithub.com/actions/cache/compare/v3.2.6...v3.3.0)

#### What's Changed

- Bug: Permission is missing in cache delete example by
[@&#8203;kotokaze](https://togithub.com/kotokaze) in
[https://github.com/actions/cache/pull/1123](https://togithub.com/actions/cache/pull/1123)
- Add `lookup-only` option by
[@&#8203;cdce8p](https://togithub.com/cdce8p) in
[https://github.com/actions/cache/pull/1041](https://togithub.com/actions/cache/pull/1041)

#### New Contributors

- [@&#8203;kotokaze](https://togithub.com/kotokaze) made their first
contribution in
[https://github.com/actions/cache/pull/1123](https://togithub.com/actions/cache/pull/1123)

**Full Changelog**: actions/cache@v3...v3.3.0

### [`v3.2.6`](https://togithub.com/actions/cache/releases/tag/v3.2.6)

[Compare
Source](https://togithub.com/actions/cache/compare/v3.2.5...v3.2.6)

##### What's Changed

- Updated branch in Force deletion of caches by
[@&#8203;t-dedah](https://togithub.com/t-dedah) in
[https://github.com/actions/cache/pull/1108](https://togithub.com/actions/cache/pull/1108)
- Fix zstd not being used after zstd version upgrade to 1.5.4 on hosted
runners by [@&#8203;pdotl](https://togithub.com/pdotl) in
[https://github.com/actions/cache/pull/1118](https://togithub.com/actions/cache/pull/1118)

**Full Changelog**: actions/cache@v3...v3.2.6

### [`v3.2.5`](https://togithub.com/actions/cache/releases/tag/v3.2.5)

[Compare
Source](https://togithub.com/actions/cache/compare/v3.2.4...v3.2.5)

##### What's Changed

- Rewrite readmes by [@&#8203;jsoref](https://togithub.com/jsoref) in
[https://github.com/actions/cache/pull/1085](https://togithub.com/actions/cache/pull/1085)
- Fixed typos and formatting in docs by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/1076](https://togithub.com/actions/cache/pull/1076)
- Fixing paths for OSes by
[@&#8203;kotewar](https://togithub.com/kotewar) in
[https://github.com/actions/cache/pull/1101](https://togithub.com/actions/cache/pull/1101)
- Release patch version update by
[@&#8203;Phantsure](https://togithub.com/Phantsure) in
[https://github.com/actions/cache/pull/1105](https://togithub.com/actions/cache/pull/1105)

##### New Contributors

- [@&#8203;jsoref](https://togithub.com/jsoref) made their first
contribution in
[https://github.com/actions/cache/pull/1085](https://togithub.com/actions/cache/pull/1085)

**Full Changelog**: actions/cache@v3...v3.2.5

</details>

<details>
<summary>github/codeql-action</summary>

###
[`v2.2.5`](https://togithub.com/github/codeql-action/compare/v2.2.4...v2.2.5)

[Compare
Source](https://togithub.com/github/codeql-action/compare/v2.2.4...v2.2.5)

###
[`v2.2.4`](https://togithub.com/github/codeql-action/compare/v2.2.3...v2.2.4)

[Compare
Source](https://togithub.com/github/codeql-action/compare/v2.2.3...v2.2.4)

</details>

<details>
<summary>trunk-io/trunk-action</summary>

###
[`v1.0.7`](https://togithub.com/trunk-io/trunk-action/releases/tag/v1.0.7)

[Compare
Source](https://togithub.com/trunk-io/trunk-action/compare/v1.0.6...v1.0.7)

Introduce a caching-only mode, controlled via `check-mode:
populate_cache_only`.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/trunk-io/plugins).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNTkuMiIsInVwZGF0ZWRJblZlciI6IjM0LjE1OS4yIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@renovate renovate Bot mentioned this pull request May 28, 2023
1 task
Dakshjain1 pushed a commit to SvavaCapital/cache that referenced this pull request Apr 19, 2024
* Improve readmes

* Add markdown for default value

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.com>

---------

Co-authored-by: Sankalp Kotewar <98868223+kotewar@users.noreply.github.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.

5 participants