Description of a component is (still) not picked up right by [addon-info]

[marcel-k]

Describe the bug
Description of a component is (still) not picked up right by addon-info.

var validMatches = [kind, name];
if (validMatches.includes(STORYBOOK_REACT_CLASSES[key].name)) {
  var componentDescription = STORYBOOK_REACT_CLASSES[key].docgenInfo.description;
  retDiv = _react.default.createElement("div", null, _this3.marksy(componentDescription).tree);
}

The above code in Story.js function _getComponentDescription only work when:

• The storiesOf 'name' parameter (kind) is exact match
• The story.add 'storyName' parameter is an exact match (when would you want to do this?)

In my situation, I want to create hierarchy by using slashes in the storiesOf 'name' and I would use the storyName to describe the test/state of the component in the story, like so:

const stories = storiesOf('atoms/button/ButtonPrimary', module);
stories.add('default', () => <ButtonPrimary /> );
stories.add('some prop', () => <ButtonPrimary  someProp={true} />);

suggested solution would be to get the hierarchySeparator and split the storyKind with it and only use the last entree in the comparison, if that is possible and doesn't break anything:

var realKind = kind.split(hierarchySeparator || '/');
var validMatches = [realKind[realKind.length - 1], name];
if (validMatches.includes(STORYBOOK_REACT_CLASSES[key].name)) {
  var componentDescription = STORYBOOK_REACT_CLASSES[key].docgenInfo.description;
  retDiv = _react.default.createElement("div", null, _this3.marksy(componentDescription).tree);
}

"react": "^16.8.4",
"@storybook/react": "^5.0.5",
"@storybook/addon-info": "^5.0.5"

[marcel-k]

Even with this fix, it still won't work with styled components though, neither does the proptable. related to #6345 ?

[stale]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

[marcel-k]

Will this be fixed in 5.1.0? #2133 this one seems related (very old though).

[shilman]

@marcel-k We're generally focusing on addon-docs, a replacement for addon-info that fixes this issue and many others.

https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a

It's currently usable in technical preview in the #docs-mode channel on our Discord https://discord.gg/UUt2PJb and will be documented as part of the 5.1 release (but officially released in 5.2)

[stale]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

[stale]

Hey there, it's me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!