Update documentation

gregorygaines · Dec 22, 2024 · 40e1aec · 40e1aec
1 parent 4e7b537
commit 40e1aec
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -254,7 +254,7 @@ let mut bitfield = BitfieldBuilder::new()
 let u8int = bitfield.u8int(); // Getters
 let small_u8int = bitfield.small_u8int(); // Signed-types are sign-extended.
 bitfield.ignore_me; // Ignored fields can be accessed directly.
-// bitfield.read_only(); // Compile error, read-only fields can't be set.
+// bitfield.set_read_only(0x3); // Compile error, read-only fields can't be set.
 
 // Setting fields:
 bitfield.set_u8int(0x3); // Setters

diff --git a/bitfields_impl/src/lib.rs b/bitfields_impl/src/lib.rs
@@ -163,7 +163,7 @@ pub(crate) const PADDING_FIELD_NAME_PREFIX: &str = "_";
 /// let u8int = bitfield.u8int(); // Getters
 /// let small_u8int = bitfield.small_u8int(); // Signed-types are sign-extended.
 /// bitfield.ignore_me; // Ignored fields can be accessed directly.
-/// // bitfield.read_only(); // Compile error, read-only fields can't be set.
+/// // bitfield.set_read_only(0x3); // Compile error, read-only fields can't be set.
 ///
 /// // Setting fields:
 /// bitfield.set_u8int(0x3); // Setters