Add some minimal docs for save_changes

sgrif · sgrif · commit fc07bb41b282 · 2017-07-05T15:56:18.000-04:00
This documentation could be improved a lot, but we should at least say
*something* about what this method does.
diff --git a/diesel/src/query_dsl/save_changes_dsl.rs b/diesel/src/query_dsl/save_changes_dsl.rs
@@ -54,6 +54,10 @@ impl<T, U> InternalSaveChangesDsl<MysqlConnection, U> for T where
 }
 
 pub trait SaveChangesDsl<Conn> {
+    /// Sugar for types which implement both `AsChangeset` and `Identifiable`
+    ///
+    /// `foo.save_changes(&conn)` is equivalent to
+    /// `update(foo::table().find(foo.id())).set(&foo).get_result(&conn)`
     fn save_changes<T>(self, connection: &Conn) -> QueryResult<T> where
         Self: InternalSaveChangesDsl<Conn, T>,
     {

Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,10 @@ impl<T, U> InternalSaveChangesDsl<MysqlConnection, U> for T where`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`pub trait SaveChangesDsl<Conn> {`
	`57`	+ /// Sugar for types which implement both `AsChangeset` and `Identifiable`
	`58`	`+ ///`
	`59`	+ /// `foo.save_changes(&conn)` is equivalent to
	`60`	+ /// `update(foo::table().find(foo.id())).set(&foo).get_result(&conn)`
`57`	`61`	`fn save_changes<T>(self, connection: &Conn) -> QueryResult<T> where`
`58`	`62`	`Self: InternalSaveChangesDsl<Conn, T>,`
`59`	`63`	`{`