📝 - docs: update docstrings

maykinmedia · Dec 6, 2024 · d6912a6 · d6912a6
1 parent 6883569
commit d6912a6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/components/data/attributelist/attributelist.tsx b/src/components/data/attributelist/attributelist.tsx
@@ -21,8 +21,11 @@ export type AttributeListProps<T extends object = object> =
   };
 
 /**
- * AttributeList component, shows multiple `fields` in `object`.
- * TODO: tooltip
+ * AttributeList Component
+ *
+ * Shows key/value pairs, optionally grouped by `title`.
+ *
+ * @typeParam T - The shape of a single item.
  */
 export const AttributeList = <T extends object = object>({
   title = "",

diff --git a/src/components/data/attributetable/attributetable.tsx b/src/components/data/attributetable/attributetable.tsx
@@ -29,7 +29,8 @@ export type AttributeTableProps<T extends object = object> = {
 /**
  * AttributeTable Component
  *
- * Shows key/value pairs, optionally grouped by `title`.
+ * Shows key/value pairs.
+ * @see DataGrid for more advanced table layout.
  *
  * @typeParam T - The shape of a single item.
  */