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

Bad handling of internal long doc comments #553

Closed
Ms2ger opened this issue Oct 31, 2015 · 3 comments
Closed

Bad handling of internal long doc comments #553

Ms2ger opened this issue Oct 31, 2015 · 3 comments
Labels
a-comments bug Panic, non-idempotency, invalid code, etc.

Comments

@Ms2ger
Copy link
Contributor

Ms2ger commented Oct 31, 2015

 fn foo() {
-    /*!
-     * This does foo stuff.
-     */
+    // !
+    // This does foo stuff.
+    //
 }
@marcusklaas marcusklaas added the bug Panic, non-idempotency, invalid code, etc. label Oct 31, 2015
@nrc nrc added the a-comments label Nov 2, 2015
@crumblingstatue
Copy link
Contributor

I'm interested in eventually running rustfmt on rust-sfml, but this bug causes missing doc comments for various items.

-/*!
- * Base module of SFML, defining various utilities.
- *
- * It provides vector classes, unicode strings and conversion functions, threads and mutexes, timing classes.
- */
+// !
+// Base module of SFML, defining various utilities.
+//
+// It provides vector classes, unicode strings and conversion functions, threads and mutexes, timing classes.
+//

@nrc
Copy link
Member

nrc commented Nov 15, 2015

Also happens with /** doc comments (why do we have so many kinds of doc comments?!):

-    /**
-    Is the package directory in the cache?
+// *
+// Is the package directory in the cache?
+//
+// Currently, this can be inferred from `emit_metadata`, but there's no *intrinsic* reason they should be tied together.
+//

@nrc
Copy link
Member

nrc commented Dec 9, 2015

I believe this is mostly fixed by #681, and that the remaining issues are covered by other issues.

@nrc nrc closed this as completed Dec 9, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-comments bug Panic, non-idempotency, invalid code, etc.
Projects
None yet
Development

No branches or pull requests

4 participants