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

Create new disambiguator to remove warning when building docs #6539

Closed
jakovljevic-mladen opened this issue Jul 28, 2021 · 0 comments · Fixed by #6540
Closed

Create new disambiguator to remove warning when building docs #6539

jakovljevic-mladen opened this issue Jul 28, 2021 · 0 comments · Fixed by #6540

Comments

@jakovljevic-mladen
Copy link
Member

Since operators are now exported from top level module (as of #6488), when building docs, a multiple warnings are produced. For example:

warn:    Error in {@link raceWith} - Ambiguous link: "raceWith".
Matching docs:
  "index/raceWith" (function) : (api/index/function/raceWith / internal/operators/raceWith.ts)
  "operators/raceWith" (function) : (api/operators/raceWith / internal/operators/raceWith.ts) - doc "api/deprecations" (deprecation)

The reason is that there are multiple documents that exist in two modules: index module and operators module. For this reason, {@link raceWith} won't work since package that builds links can't decide which one to take. Thus, a new disambiguator should be created to remove operators from operators module.

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

Successfully merging a pull request may close this issue.

1 participant