Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign updocs: RouterTestingModule should be added to Testing guide #34341
Comments
|
Agreed on the "helpful" note. According to guidelines it's ideal for documentation not to make references to what "should" come in the future. Instead, we're supposed to stick with what we're documenting in the present moment. Note for docs team: when this becomes a PR, we'll need to remove this note and sweep for any other future-related notes in there. |
|
@kapunahelewong can I take this issue |
|
Yes, @ajitsinghkaler, thank you!! Please let me know if you need help with any of the issues you've volunteered for. |
|
The alert seems to be directly related to the preceding paragraph:
What's the scope for this issue? Adding a guide for different types of tests using the |
|
Good questions, @LayZeeDK. These are exactly the kinds of questions we are discussing with in the docs team as we rework a lot of the documentation. Do you have any particular thoughts on the scope and types of example tests that you'd be interested in? If you search for something regarding testing what are the topics that first come to mind? Your use cases would also be interesting to hear. If you or others would like to log your thoughts here in this issue I'd be happy to link to this issue from the Jira as context for the writer. |
|
Different types of tests involving the
|
|
I've been intensively looking into this 3 year old issue for the past week: I feel more and more convinced that for the most part we don't need to extend our testing APIs to close it, but rather write a guide covering the types of tests listed above. |
|
Thank you, @LayZeeDK! I've added this and #15779 to the Jira work item so the writer who works on it can refer back for context. Docs team: See https://angular-team.atlassian.net/browse/DOCS-784 |
Description
The Testing Guide has the following "helpful"
alert:This was added as part of PR #20697 in 2017. Since this hasn't been addressed yet, I figured it would be a good idea to open an issue to ensure that it gets documented.
There are some minimal RouterTestingModule API docs but they are not sufficient. This is something that really needs to be included in the Testing Guide. Both for Services that cause routing and components.
What's the affected URL?**
Guide: https://angular.io/guide/testing#what-good-are-these-tests
Source: https://github.com/angular/angular/blame/fe4447d56860c55000bc7424a61462b6de8596e5/aio/content/guide/testing.md#L2250-L2251