Skip to content

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