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

Misleading example in multi-language support docs #8986

Closed
nicolaiunrein opened this issue Aug 11, 2024 · 0 comments · Fixed by #8992
Closed

Misleading example in multi-language support docs #8986

nicolaiunrein opened this issue Aug 11, 2024 · 0 comments · Fixed by #8992
Labels
area: docs Improvements or additions to documentation

Comments

@nicolaiunrein
Copy link

nicolaiunrein commented Aug 11, 2024

What is the improvement or update you wish to see?

In the Multi-language support section of the docs there is this example:

{
  "name": "@repo/rust-cli",
  "scripts": {
    "build": "cargo build"
  }
}

and later

{
  "tasks": {
    "build": {
      "outputs": ["target/release/**"] 
    }
  }
}

however the cargo build command will generate artifacts at target/debug. I would suggest the following change to the docs

{
  "name": "@repo/rust-cli",
  "scripts": {
-    "build": "cargo build"
+    "build": "cargo build —release"
  }
}

Is there any context that might help us understand?

The changes would prevent confusion especially among inexperienced rust developers or when copy/pasting. Because the given example is not working as it is today.

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

https://turbo.build/repo/docs/guides/multi-language

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants