documentationjs / documentationjs/documentation
toc.name collisions with types
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 481
- PR merge metrics
- No merged PRs in 30d
Description
I have a class named `Foo` that I'm documenting. However, if I put narrative section with a `name` property of `Foo` it becomes collapsable, with the the `Foo` properties/methods underneath it. If I name it something else, like `Blah`, where `Blah` is not a type, it’s rendered as an unclickable section heading. I’d expect the latter behavior regardless if the name matches an existing class.
```json
{ "toc":
[
{
"name": "Foo.",
"description": "Things related to Foo"
},
"Foo",
"MoreSpecificFoo",
{
"name": "Other Stuff",
"description": "Non-Foo stuff"
},
"Bar",
"Baz"
]
}
```
Maybe I don’t understand how the TOC is supposed to work. Any guidance would be appreciated.
documentation: 4.0.0-beta14
node: v6.5.0
npm: 3.10.3
macOS: 10.11.6
Contributor guide
Assessment
This issue has not been assessed yet.