Key trait docs.

Byron · Jan 30, 2024 · f1d7e94 · f1d7e94
1 parent 04d0be3
commit f1d7e94
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/gix-config/src/traits.rs b/gix-config/src/traits.rs
@@ -1,11 +1,11 @@
 use bstr::BStr;
 
-/// TODO
+/// Parsed elements of a Git config key, like `remote.origin.url` or `core.bare`.
 pub trait Key {
-    /// TODO
+    /// The name of the section key, like `url` in `remote.origin.url`.
     fn name(&self) -> &str;
-    /// TODO
+    /// The name of the section, like `core` in `core.bare`.
     fn section_name(&self) -> &str;
-    /// TODO
+    /// The name of the sub-section, like `origin` in `remote.origin.url`.
     fn subsection_name(&self) -> Option<&BStr>;
 }