Skip to content

Add a note about not preserving comments and whitespace #110

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.

Sign up for GitHub

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

Open
cramertj wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a note about not preserving comments and whitespace #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ The tradeoffs made by this crate are a good fit for generated code that you will
output of `cargo-expand`. In those cases it's more important that the whole
thing be formattable without the formatter giving up, than that it be flawless.

Note that this crate does not support preserving non-doc comments or whitespace.

<br>

## Feature matrix
Expand All @@ -58,6 +60,7 @@ detail comparing the output of each of these libraries.
| published to crates.io | 💚 | ❌ | ❌ |
| extensively configurable output | ❌ | ❌ | 💚 |
| intended to accommodate hand-maintained source code | ❌ | ❌ | 💚 |
| preserves comments and whitespace | ❌ | 💚 | 💚 |

<br>

Expand Down