Improved contributing docs in web-sys README
#4302
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daxpedda
approved these changes
Dec 6, 2024
| 3. `cd crates/web-sys` | ||
| 4. Run `cargo run --release --package wasm-bindgen-webidl -- webidls src/features ./Cargo.toml` | ||
|
|
||
| If formatting fails, you can run `cargo fmt` in the `crates/web-sys` directory. On Windows, you might also want to run `cargo fmt -- --config newline_style=Unix` depending on your git configuration. |
There was a problem hiding this comment.
- Considering you are running Windows, could you try and see if prefixing paths with
\\?\fixes the issue on Windows? - We should set this configuration in the
rustfmt.tomlfile (which we don't have, so feel free to create one).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
crates/web-sysfor the commands to work.cargo fmtworked, so I added a note for that.cargo fmtdid work, it also used CRLF on Windows. I have git setup to check out everything as is (and WBG is LF) to make contributing to cross-platform repos easier. Socargo fmtresulted in ~2k changed files because of the different line endings. I added a note with how to fix that.