docs: improve jsdoc of some components

jtiala · Jan 25, 2024 · 256595f · 256595f
1 parent 535ebfb
commit 256595f
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/packages/react/src/components/Anchor/Anchor.tsx b/packages/react/src/components/Anchor/Anchor.tsx
@@ -72,7 +72,7 @@ export type AnchorProps = {
 const className = cn("anchor");
 
 /**
- * Display a hyperlink.
+ * A hyperlink used for navigation within the application or to external resources.
  */
 export function Anchor({
   href,

diff --git a/packages/react/src/components/Button/Button.tsx b/packages/react/src/components/Button/Button.tsx
@@ -43,7 +43,7 @@ export type ButtonProps = {
 const className = cn("button");
 
 /**
- * A clickable UI element commonly used to trigger actions, such as submitting a form.
+ * An interactive element used for triggering actions. Shouldn't be used for navigating.
  */
 export function Button({
   type = "button",

diff --git a/packages/react/src/components/Input/Input.tsx b/packages/react/src/components/Input/Input.tsx
@@ -64,7 +64,7 @@ export type InputProps = {
 const className = cn("input");
 
 /**
- * Display an input.
+ * A input field that can be used for various input scenarios.
  */
 export function Input({
   type = "text",

diff --git a/packages/react/src/components/Stack/Stack.tsx b/packages/react/src/components/Stack/Stack.tsx
@@ -18,7 +18,7 @@ const verticalClassName = cn("stack-vertical");
 const horizontalClassName = cn("stack-horizontal");
 
 /**
- * Display a stack of items.
+ * A layout element for stacking content.
  */
 export function Stack({
   direction = "vertical",

diff --git a/packages/react/src/components/Textarea/Textarea.tsx b/packages/react/src/components/Textarea/Textarea.tsx
@@ -59,7 +59,7 @@ export type TextareaProps = {
 const className = cn("textarea");
 
 /**
- * Display an textarea.
+ * Capture user input as multiline text.
  */
 export function Textarea({
   name,