doc examples for write

Author: burrbull

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Add new feature `feature_group` which will generate cfg attribute for
   every group name when it is on
 - Sort fields by offset before process
-- advanced comments
+- Updated docs for `write` / `modify`
 
 ## [v0.24.1] - 2022-07-04
 

src/generate/generic.rs

@@ -99,6 +99,14 @@ impl<REG: Resettable + Writable> Reg<REG> {
     ///     .field3().variant(VARIANT)
     /// );
     /// ```
+    /// or an alternative way of saying the same:
+    /// ```ignore
+    /// periph.reg.write(|w| {
+    ///     w.field1().bits(newfield1bits);
+    ///     w.field2().set_bit();
+    ///     w.field3().variant(VARIANT)
+    /// });
+    /// ```
     /// In the latter case, other fields will be set to their reset value.
     #[inline(always)]
     pub fn write<F>(&self, f: F)
@@ -154,6 +162,14 @@ impl<REG: Readable + Writable> Reg<REG> {
     ///     .field3().variant(VARIANT)
     /// );
     /// ```
+    /// or an alternative way of saying the same:
+    /// ```ignore
+    /// periph.reg.modify(|_, w| {
+    ///     w.field1().bits(newfield1bits);
+    ///     w.field2().set_bit();
+    ///     w.field3().variant(VARIANT)
+    /// });
+    /// ```
     /// Other fields will have the value they had before the call to `modify`.
     #[inline(always)]
     pub fn modify<F>(&self, f: F)