Skip to content

Explicitly enumerate limitations #2109

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

Closed
nrc opened this issue Nov 2, 2017 · 1 comment
Closed

Explicitly enumerate limitations #2109

nrc opened this issue Nov 2, 2017 · 1 comment

Comments

@nrc
Copy link
Member

nrc commented Nov 2, 2017

In the README or somewhere similarly prominent we should enumerate the known limitations of Rustfmt.

For 1.0, the limitations I'm aware of:

  • code must parse
  • whole programs only (we can do better than this, but this is all we 'guarantee'
  • we don't touch comments
  • macros might be sub-optimally formatted
  • no guarantees if there are wide unicode chars (make sure we work with unicode #6), but things should mostly work
  • there might be bugs, of course, because software
@nrc nrc added this to the 1.0 milestone Nov 2, 2017
@nrc nrc mentioned this issue Nov 2, 2017
10 tasks
@topecongiro
Copy link
Contributor

  • we cannot format some expressions (e.g. method chain and binary operations) with comments

@nrc nrc closed this as completed in c829875 Mar 8, 2018
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

No branches or pull requests

2 participants