Add documentation comment

1 files changed, 16 insertions, 0 deletions

diff --git a/crates/ra_assists/src/handlers/reorder_fields.rs b/crates/ra_assists/src/handlers/reorder_fields.rs
index 100e1feb1..661c1bf54 100644
--- a/crates/ra_assists/src/handlers/reorder_fields.rs
+++ b/crates/ra_assists/src/handlers/reorder_fields.rs
@@ -16,6 +16,22 @@ use crate::{
 };
 use ra_syntax::ast::{Expr, NameRef};
 
+
+// Assist: reorder_fields
+//
+// Reorder the fields of record literals and record patterns in the same order as in
+// the definition.
+//
+// ```
+// struct Foo {foo: i32, bar: i32};
+// const test: Foo = <|>Foo {bar: 0, foo: 1}
+// ```
+// ->
+// ```
+// struct Foo {foo: i32, bar: i32};
+// const test: Foo = <|>Foo {foo: 1, bar: 0}
+// ```
+//
 pub(crate) fn reorder_fields(ctx: AssistCtx) -> Option<Assist> {
     reorder::<RecordLit>(ctx.clone()).or_else(|| reorder::<RecordPat>(ctx))
 }