You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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. 🤔
Description Of The Issue
In the docs app, overload signatures are shown for methods on
Observable
- e.g. five overload signatures are shown forsubscribe
.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 forretry
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.The text was updated successfully, but these errors were encountered: