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

Generated documentation includes function duplicates when the functions are overloaded. #7

Open
NZepeda opened this issue May 27, 2021 · 1 comment
Labels
bug Something isn't working

Comments

@NZepeda
Copy link

NZepeda commented May 27, 2021

Summary

Having overloaded functions such as the example below will produce function duplicates in the generated documentation:

function func(key: "dashboard"): ContentRecord<DashboardMetaData> {}
function func(key: "widget"): ContentRecord<WidgetMetaData> {}
function func(key: "filter"): ContentRecord<FilterMetaData> {}

function func(key: ContentType): ContentRecord<DashboardMetaData> | ContentRecord<WidgetMetaData> | ContentRecord<FilterMetaData> {
 ...impl
}
@Nouzbe Nouzbe added the bug Something isn't working label Feb 23, 2023
@Nouzbe
Copy link
Collaborator

Nouzbe commented Feb 23, 2023

@NZepeda is this bug still valid? I was looking for an example of bad generated documentation. One that came to mind is https://activeviam.com/activeui/documentation/latest/docs/api/hooks#usetree. But it seems to be correctly generated.

If this issue does not exist any more, could you close it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants