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: --cache docs confusing #9481

Closed
dipunm opened this issue Nov 21, 2024 · 2 comments · Fixed by #9489
Closed

📚 Docs: --cache docs confusing #9481

dipunm opened this issue Nov 21, 2024 · 2 comments · Fixed by #9489

Comments

@dipunm
Copy link

dipunm commented Nov 21, 2024

What is the improvement or update you wish to see?

The statement:

When an option is omitted, reading and writing are both disabled

in https://github.com/vercel/turborepo/blob/main/docs/repo-docs/reference/run.mdx#--cache-options

Is confusing.

Is there any context that might help us understand?

I ran locally, and I believe it should say "reading and writing are both enabled". I thought maybe it meant if you omit the :rw part, but it just errors if you omit that (unless you use local:,remote:).

Does the docs page already exist? Please link to it.

in https://github.com/vercel/turborepo/blob/main/docs/repo-docs/reference/run.mdx#--cache-options

@anthonyshew
Copy link
Contributor

anthonyshew commented Nov 21, 2024

Would you have found it clearer if it was:

When a caching source is omitted, reading and writing for that source are both disabled.

@anthonyshew anthonyshew linked a pull request Nov 21, 2024 that will close this issue
@anthonyshew
Copy link
Contributor

Re-reading this now, I can see how it can be clearer in a handful of ways. Thank you for pointing this out. Hopefully it will be clearer after #9489.

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 a pull request may close this issue.

2 participants