fact-check the docs for rustdoc-json-types

Author: its-the-shrimp

src/rustdoc-json-types/lib.rs

@@ -923,13 +923,13 @@ pub enum Term {
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 #[serde(rename_all = "snake_case")]
 pub enum Type {
-    /// Structs, enums, unions, etc., e.g. `std::option::Option<u32>`
+    /// Structs, enums, unions and type aliases, e.g. `std::option::Option<u32>`
     ResolvedPath(Path),
     /// Dynamic trait object type (`dyn Trait`).
     DynTrait(DynTrait),
     /// Parameterized types. The contained string is the name of the parameter.
     Generic(String),
-    /// Built-in types, such as the integers, floating-point numbers, `bool`, `char`.
+    /// Built-in numeric types (e.g. `u32`, `f32`), `bool`, `char`.
     Primitive(String),
     /// A function pointer type, e.g. `fn(u32) -> u32`, `extern "C" fn() -> *const u8`
     FunctionPointer(Box<FunctionPointer>),
@@ -942,8 +942,9 @@ pub enum Type {
         /// The type of the contained element.
         #[serde(rename = "type")]
         type_: Box<Type>,
-        /// The stringified expression that is the length of the array. Keep in mind that it's not
-        /// guaranteed to match the actual source code of the expression.
+        /// The stringified expression that is the length of the array.
+        ///
+        /// Keep in mind that it's not guaranteed to match the actual source code of the expression.
         len: String,
     },
     /// A pattern type, e.g. `u32 is 1..`
@@ -1059,7 +1060,8 @@ pub struct FnDecl {
     /// The output type, if specified.
     pub output: Option<Type>,
     /// Whether the function accepts an arbitrary amount of trailing arguments the C way.
-    /// ```text
+    ///
+    /// ```ignore (incomplete code)
     /// fn printf(fmt: &str, ...);
     /// ```
     pub c_variadic: bool,
@@ -1103,8 +1105,8 @@ pub struct Impl {
     pub is_unsafe: bool,
     /// Information about the impl’s type parameters and `where` clauses.
     pub generics: Generics,
-    /// The list of names for all provided methods in this impl block. This is provided for
-    /// ease of access if you don’t need more information from the items field.
+    /// The list of the names of all the trait methods that weren't mentioned in this impl but
+    /// were provided by the trait itself.
     ///
     /// For example, for this impl of the [`PartialEq`] trait:
     /// ```rust
@@ -1114,9 +1116,9 @@ pub struct Impl {
     ///     fn eq(&self, other: &Self) -> bool { todo!() }
     /// }
     /// ```
-    /// This field will be `["eq"]`
+    /// This field will be `["ne"]`, as it has a default implementation defined for it.
     pub provided_trait_methods: Vec<String>,
-    /// The trait being implemented or `None` if the impl is “inherent”, which means
+    /// The trait being implemented or `None` if the impl is inherent, which means
     /// `impl Struct {}` as opposed to `impl Trait for Struct {}`.
     #[serde(rename = "trait")]
     pub trait_: Option<Path>,
@@ -1130,13 +1132,7 @@ pub struct Impl {
     /// Whether this is an impl that’s implied by the compiler
     /// (for autotraits, e.g. `Send` or `Sync`).
     pub synthetic: bool,
-    /// If this is a blanket impl, the name with which [`for_`] is referred to in the original impl.
-    ///
-    /// E.g., for `impl<T, U> Into<U> for T` this field would be `T`.
-    ///
-    /// The contained [`Type`], if present, is always of kind [`Type::Generic`]
-    ///
-    /// [`for_`]: Impl::for_
+    // FIXME: document this
     pub blanket_impl: Option<Type>,
 }