partially fix docs

Author: philipch07

crates/amf0/README.md

@@ -19,38 +19,37 @@
 A pure-rust implementation of AMF0 encoder and decoder.
 
 This crate provides serde support for serialization and deserialization of AMF0 data.
+## Specification
 
-See the [changelog](./CHANGELOG.md) for a full release history.
+| Name | Version | Link | Comments |
+| --- | --- | --- | --- |
+| Action Message Format -- AMF 0 | - | <https://rtmp.veriskope.com/pdf/amf0-file-format-specification.pdf> | Refered to as 'AMF0 spec' in this documentation |
 
-### Feature flags
+## Limitations
 
-* **`serde`** —  Enables serde support
-* **`docs`** —  Enables changelog and documentation of feature flags
+- Does not support AMF0 references.
+- Does not support the AVM+ Type Marker. (see AMF 0 spec, 3.1)
 
-### Specification
+## Example
 
-|Name|Version|Link|Comments|
-|----|-------|----|--------|
-|Action Message Format – AMF 0|-|<https://rtmp.veriskope.com/pdf/amf0-file-format-specification.pdf>|Refered to as ‘AMF0 spec’ in this documentation|
-
-### Limitations
-
-* Does not support AMF0 references.
-* Does not support the AVM+ Type Marker. (see AMF 0 spec, 3.1)
-
-### Example
-
-````rust
+```rust
+# fn test() -> Result<(), Box<dyn std::error::Error>> {
+# let bytes = &[0x02, 0, 1, b'a'];
+# let mut writer = Vec::new();
 // Decode a string value from bytes
 let value: String = scuffle_amf0::from_slice(bytes)?;
 
 // .. do something with the value
 
 // Encode a value into a writer
 scuffle_amf0::to_writer(&mut writer, &value)?;
-````
+# assert_eq!(writer, bytes);
+# Ok(())
+# }
+# test().expect("test failed");
+```
 
-### License
+## License
 
 This project is licensed under the MIT or Apache-2.0 license.
 You can choose between one of them if you use this work.

crates/amf0/src/decoder.rs

@@ -379,7 +379,10 @@ mod tests {
             *object.get(&StringCow::from_static("abc")).unwrap(),
             Amf0Value::String("val".into())
         );
-        assert_eq!(*object.get("defg").unwrap(), Amf0Value::Boolean(true));
+        assert_eq!(
+            *object.get(&StringCow::from_static("defg")).unwrap(),
+            Amf0Value::Boolean(true)
+        );
     }
 
     #[test]

crates/amf0/src/encoder.rs

@@ -83,7 +83,7 @@ where
         Ok(())
     }
 
-    /// Encode an [`Amf0Array`] as an AMF0 StrictArray value.
+    /// Encode an Amf0Array as an AMF0 StrictArray value.
     pub fn encode_array<'a, I, B>(&mut self, values: I) -> Result<(), Amf0Error>
     where
         B: Borrow<Amf0Value<'a>>,

crates/amf0/src/lib.rs

@@ -41,7 +41,7 @@
 //!
 //! `SPDX-License-Identifier: MIT OR Apache-2.0`
 #![cfg_attr(all(coverage_nightly, test), feature(coverage_attribute))]
-#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 #![deny(missing_docs)]
 #![deny(unsafe_code)]
 #![deny(unreachable_pub)]

crates/amf0/src/object.rs

@@ -1,4 +1,4 @@
-//! This code is modified from https://github.com/serde-rs/json/blob/v1.0.140/src/map.rs
+//! This code is modified from <https://github.com/serde-rs/json/blob/v1.0.140/src/map.rs>
 //!
 //! A map of scuffle_bytes_util::StringCow to crate::Amf0Value.
 //!
@@ -362,13 +362,6 @@ impl<'a> Amf0Object<'a> {
     /// favor of an alphanumerical order that matches how a BTreeMap with the
     /// same contents would be ordered. This takes **O(n log n + c)** time where
     /// _n_ is the length of the map and _c_ is the capacity.
-    ///
-    /// Other maps nested within the values of this map are not sorted. If you
-    /// need the entire data structure to be sorted at all levels, you must also
-    /// call
-    /// <code>map.[values_mut]\().for_each([Value::sort_all_objects])</code>.
-    ///
-    /// [values_mut]: Map::values_mut
     #[inline]
     pub fn sort_keys(&mut self) {
         #[cfg(feature = "preserve_order")]
@@ -640,9 +633,9 @@ where
 //////////////////////////////////////////////////////////////////////////////
 
 /// A view into a single entry in a map, which may either be vacant or occupied.
-/// This enum is constructed from the [`entry`] method on [`Map`].
+/// This enum is constructed from the [`entry`] method on [`Amf0Object`].
 ///
-/// [`entry`]: Map::entry
+/// [`entry`]: Amf0Object::entry
 pub enum Entry<'a, 'b> {
     /// A vacant Entry.
     Vacant(VacantEntry<'a, 'b>),