patternfly / patternfly/patternfly-org

Composable table docs: `Prop component IActions missing from tsDocgen`

Open
#2,758 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation wontfix
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

I have been seeing this warning appear in the dev server log when working on https://github.com/patternfly/patternfly-react/pull/6168:

Screen Shot 2021-11-23 at 5 49 21 PM

I didn't think much of it until now, but I realized that the IActions type is not rendering at all in the Props section of the table docs pages. It is listed in the propComponents array at the top of ComposableTable.md, but the workspace can't find it.

The type definition is:

export type IActions = (IAction | ISeparator)[];

It's worth noting that if I put IAction or ISeparator into that propComponents array those render properly. So it seems there is an issue with parsing type declarations rather than interfaces. I'm not sure how we would render them though.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the propComponents entry in ComposableTable.md and trace how the workspace's tsDocgen resolves those names. Compare the handling of IActions with IAction and ISeparator, then verify that the IActions type declaration renders in the Props section of the composable table docs without the warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.