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: Added rel path to --out-dir example #1463

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rimutaka
Copy link

@rimutaka rimutaka commented Jan 10, 2025

Make sure these boxes are checked! 📦✅

  • You have the latest version of rustfmt installed
$ rustup component add rustfmt
  • You ran cargo fmt on the code base before submitting
  • You reference which issue is being closed in the PR text
    > not applicable, it's a minor docs fix

This PR adds relative path examples to --out-dir docs section.

The current wording does not make it clear if the path is relative to the current directory or the root of the package.
The proposed clarification and the examples should make it less ambiguous and save the users from figuring it out by trial and error.

@rimutaka rimutaka marked this pull request as ready for review January 10, 2025 09:07
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.

1 participant