patternfly-org icon indicating copy to clipboard operation
patternfly-org copied to clipboard

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

Open mturley opened this issue 4 years ago • 2 comments

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.

mturley avatar Nov 23 '21 22:11 mturley

This might belong in the patternfly-org repo? (edit: transferred)

mturley avatar Nov 23 '21 22:11 mturley

This may or may not still be an issue once we migrate our documentation framework

edonehoo avatar Dec 10 '24 18:12 edonehoo