feat: in-manifest and in-lib feature documentation (#329)

cargo-features.md

@@ -84,7 +84,7 @@ The library powering the command-line interface.
 
 ### git-actor
 
-Documented in [its documnetation](https://docs.rs/git-actor).
+Documented in [its documentation](https://docs.rs/git-actor).
 
 ### git-features
 
@@ -178,11 +178,7 @@ be selected.
 
 ### git-object
 
-* **verbose-object-parsing-errors**
-  - When parsing objects by default errors will only be available on the granularity of success or failure, and with the above flag enabled
-    details information about the error location will be collected.
-  - Use it in applications which expect broken or invalid objects or for debugging purposes. Incorrectly formatted objects aren't at all
-    common otherwise.
+Documented in [its documentation](https://docs.rs/git-object).
 
 ### git-repository
 

git-object/Cargo.toml

@@ -14,11 +14,12 @@ doctest = false
 [features]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1", "smallvec/serde", "git-hash/serde1", "git-actor/serde1"]
+## When parsing objects by default errors will only be available on the granularity of success or failure, and with the above flag enabled
+## details information about the error location will be collected.
+## Use it in applications which expect broken or invalid objects or for debugging purposes. Incorrectly formatted objects aren't at all
+## common otherwise.
 verbose-object-parsing-errors = ["nom/std"]
 
-[package.metadata.docs.rs]
-all-features = true
-
 [dependencies]
 git-features = { version = "^0.19.1", path = "../git-features", features = ["rustsha1"] }
 git-hash = { version = "^0.9.2", path = "../git-hash" }
@@ -34,6 +35,13 @@ nom = { version = "7", default-features = false, features = ["std"]}
 smallvec = { version = "1.4.0", features = ["write"] }
 serde = { version = "1.0.114", optional = true, default-features = false, features = ["derive"]}
 
+document-features = { version = "0.1", optional = true }
+
 [dev-dependencies]
 pretty_assertions = "1.0.0"
 git-testtools = { path = "../tests/tools"}
+
+[package.metadata.docs.rs]
+features = ["document-features"]
+all-features = true
+

git-object/src/lib.rs

@@ -1,5 +1,10 @@
 //! This crate provides types for [read-only git objects][crate::ObjectRef] backed by bytes provided in git's serialization format
 //! as well as [mutable versions][Object] of these. Both types of objects can be encoded.
+//! ## Feature Flags
+#![cfg_attr(
+    feature = "document-features",
+    cfg_attr(doc, doc = ::document_features::document_features!())
+)]
 #![forbid(unsafe_code)]
 #![deny(rust_2018_idioms, missing_docs)]