palantir/blueprint

Docs: RowHeaderCell documentation missing

Open

#5,118 opened on Feb 7, 2022

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: documentationP2Package: tablehelp wanted

Description

This component is importable and usable but is not documented in the JavaScript API of the Table component. Of course its easy enough to look in the codebase but seems like an omission since its counterpart for columns is well documented.

Thanks.

Contributor guide

Tech stack
typescriptreact
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Reactbasic understanding of documentation practices
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests adding documentation for RowHeaderCell component. The component is located in packages/table/src/headers/rowHeaderCell.tsx. Since the counterpart (column header cell) is already documented, you can use its documentation as a template. Look at the existing Table JavaScript API docs to understand the format and add the missing entry.