Rollup merge of #101648 - Timmmm:home_dir_docs, r=joshtriplett

[rust.git] / src / rustdoc-json-types / lib.rs

diff --git a/src/rustdoc-json-types/lib.rs b/src/rustdoc-json-types/lib.rs
index dd40f3507523c1a612bd7793e98ca0ead7717fe1..1ee96b8231cd1418349c17977a645c44d2d75a2c 100644 (file)
--- a/src/rustdoc-json-types/lib.rs
+++ b/src/rustdoc-json-types/lib.rs
@@ -615,6 +615,10 @@ pub struct FunctionPointer {
 
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct FnDecl {
+    /// List of argument names and their type.
+    ///
+    /// Note that not all names will be valid identifiers, as some of
+    /// them may be patterns.
     pub inputs: Vec<(String, Type)>,
     pub output: Option<Type>,
     pub c_variadic: bool,