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

Operator overload signatures are not shown in docs app #5281

Closed
cartant opened this issue Jan 30, 2020 · 4 comments
Closed

Operator overload signatures are not shown in docs app #5281

cartant opened this issue Jan 30, 2020 · 4 comments
Assignees
Labels
docs Issues and PRs related to documentation

Comments

@cartant
Copy link
Collaborator

cartant commented Jan 30, 2020

Description Of The Issue

In the docs app, overload signatures are shown for methods on Observable - e.g. five overload signatures are shown for subscribe.

However, overload signatures are not shown for operators. That makes documenting shareReplay somewhat difficult, as it has a number of signatures - including a signature that takes a single config object. The same problem exists for the config object signature added for retry in this PR.

It's not clear what needs to be done to effect the showing of overload signatures for operators and I'm not sure what it is that effects them for Observable#subscribe - as there doesn't seem to be anything specific to overloads in the TSDoc.

@cartant cartant added the docs Issues and PRs related to documentation label Jan 30, 2020
@dzhavat
Copy link
Contributor

dzhavat commented Jan 31, 2020

It might sound funny but I just added a 3rd signature function to the shareReplay operator, rebuild the docs, launched them, and now the Overloads section is there.

image

image

I did the opposite with the mergeMap operator. Deleted a signature function to just two (from three) and the Overloads section is not there.

So there's something with having a minimum number of signatures before they appear in the docs. 🤔

@cartant
Copy link
Collaborator Author

cartant commented Jan 31, 2020

@dzhavat Nice find.

@dzhavat
Copy link
Contributor

dzhavat commented Feb 1, 2020

Looks like my observation above is correct. Here's how the Overloads section is build :)

@jakovljevic-mladen
Copy link
Member

Closed in #7367.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants