Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Issues with nested components with similar names

See original GitHub issue

I have a set of two components, step-manager and step-manager/step (which is yield-ed by the manager). I’m running into a number of issues with this scenario

I can’t generate a documentation page for the step-manager/step component because I get an error about the name already being used

The properties on the step-manager/step component appear on the step-manager page when turning documentation for step-manager/step off

Issue Analytics

State:
Created 6 years ago
Reactions:1
Comments:13 (10 by maintainers)

Top GitHub Comments

1reaction

alexlafrosciacommented, Mar 14, 2018

Yeah, totally! Would you be interested in a PR that allows for documenting nested components correctly? Or is there a desire to push people away from that pattern for addons?

My use case is documenting a contextual component that’s yielded out of the step-manager. Maybe that is actually the problem to solve. Documentation for step-manager/step doesn’t really make sense because you’d never use it alone, but I don’t know where else to document its API.

0reactions

markcelluscommented, Apr 28, 2018

Just ran into this same issue, but my issue is not because of two nested components, but rather component name prefixes/namespace. I have my-button and my-button-list and it is matching both of them and giving me the same error.