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

UrlMatcher should be exported or removed from the API docs #15140

Closed
Foxandxss opened this issue Mar 14, 2017 · 3 comments
Closed

UrlMatcher should be exported or removed from the API docs #15140

Foxandxss opened this issue Mar 14, 2017 · 3 comments

Comments

@Foxandxss
Copy link
Member

Foxandxss commented Mar 14, 2017

I'm submitting a ... (check one with "x")

[x] bug report => search github for a similar issue or PR before submitting
[ ] feature request
[ ] support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question

Current behavior

The Router interface uses UrlMatcher and UrlMatcher is not exported.

Expected behavior

The UrlMatcher should be exported as well. We have documentation for it but leads to a 404.

What is the motivation / use case for changing the behavior?

I am a member of the docs team and we get an issue every other week about the UrlMatcher link here leading to a 404.

There are a few issues in this repo, a few issues on aio repo. I decided to investigate the issue with @petebacondarwin to see if that was a dgeni issue and we discovered (well, he did) that dgeni is not parsing out the UrlMatcher documentation which exist here because at the end, the UrlMatcher is not exported with the barrel.

I am in no position to assert that it should be public or not, but we can't document it otherwise, so it would be better to decide in make it public or remove the link from the API since we cannot document it (and I think we shouldn't if it is not public).

@IgorMinar IgorMinar added this to the 4.0.0-blocker-candidates milestone Mar 14, 2017
@IgorMinar
Copy link
Contributor

I'm marking this as a candidate for 4.0.0 because it's an easy fix and currently results in issues in our docs infrastructure. // @vicb

DzmitryShylovich added a commit to DzmitryShylovich/angular that referenced this issue Mar 30, 2017
@Foxandxss
Copy link
Member Author

I don't see this anymore in the API docs @IgorMinar . Should we close or ... ?

IgorMinar added a commit to IgorMinar/angular that referenced this issue Jun 24, 2017
IgorMinar added a commit to IgorMinar/angular that referenced this issue Jun 27, 2017
IgorMinar added a commit to IgorMinar/angular that referenced this issue Jun 30, 2017
jasonaden pushed a commit to jasonaden/angular that referenced this issue Jul 8, 2017
jasonaden pushed a commit to jasonaden/angular that referenced this issue Jul 8, 2017
asnowwolf pushed a commit to asnowwolf/angular that referenced this issue Aug 11, 2017
juleskremer pushed a commit to juleskremer/angular that referenced this issue Aug 28, 2017
jmleoni pushed a commit to jmleoni/angular that referenced this issue Oct 6, 2018
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants