Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Classes with same name don't have differentiating h3 anchor tags. #832

Open
mbonig opened this issue Nov 8, 2022 · 0 comments
Open

Classes with same name don't have differentiating h3 anchor tags. #832

mbonig opened this issue Nov 8, 2022 · 0 comments

Comments

@mbonig
Copy link

mbonig commented Nov 8, 2022

In a project with the following setup:

.
-- namespace1
-- SomeClass
-- namespace2
-- SomeClass

Will result in an API.md where both h3 anchors have the same name:

### SomeClass <a name="SomeClass" id="namespace1.SomeClass"></a>
### SomeClass <a name="SomeClass" id="namespace2.SomeClass"></a>

When rendering these docs (using something like docusaurus) the names are not distinct enough and causes confusion as namespaces are not printed anywhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant