Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit 1dfa856

Browse files
committed
Fix heading docblock
1 parent 55a1f05 commit 1dfa856

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

components/atoms/Heading/Heading.js

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@ import PropTypes from 'prop-types'
33
import React from 'react'
44

55
/**
6-
* @param props0
7-
* @param props0.children
8-
* @param props0.className
9-
* @param props0.id
10-
* @param props0.tag
6+
* Render the Heading component.
7+
*
8+
* @param {object} props The props object.
9+
* @param {string} props.children The elements or text you'd like to render inside the heading.
10+
* @param {string} props.className The optional classname.
11+
* @param {string} props.id The optional ID.
12+
* @param {string} props.tag The tag name you'd like the heading to render as.
13+
* @return {Element} The Heading element.
1114
*/
1215
export default function Heading({children, className, id, tag}) {
1316
if (typeof children === 'string') {

0 commit comments

Comments
 (0)