Skip to content

Documentation error which says NgModule instead of BrowserModule #22158

Closed

Description

@shrivatsahosabettu

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Feature request
[x] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question

Current behavior

In Architecture Overview --> Angular Libraries
as in the below screen print it says "You also import NgModules from Angular libraries using JavaScript import statements:" which is in contradiction with the example shown in the code
image

Expected behavior

The description should have been "You also import BroserModul from Angular libraries using JavaScript import statements:" to inline with the code example given

Minimal reproduction of the problem with instructions

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

Environment


Angular version: X.Y.Z


Browser:
- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
- [ ] Firefox version XX
- [ ] Safari (desktop) version XX
- [ ] Safari (iOS) version XX
- [ ] IE version XX
- [ ] Edge version XX
 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

Activity

  1. trotyl commented on Feb 12, 2018

    @trotyl
    Contributor

    Please note the s(plural), BrowserModule is only an example used, your app may import several different others NgModules as well, nothing wrong with that.

    Would you suggest something like:

    You also import NgModules (eg. BrowserModule) from Angular libraries using JavaScript import statements?

  2. shrivatsahosabettu commented on Feb 12, 2018

    @shrivatsahosabettu
    Author

    Yes, that would be lot better.. Thanks for your comments.

  3. jenniferfell commented on Feb 15, 2018

    @jenniferfell
    Contributor

    Thank you for your feedback. We've done some work on the Architecture doc. We've expanded the information about NgModules in #21569. Does this sufficiently address this potential point of confusion?

  4. added this to the needsTriage milestone on Feb 26, 2018
  5. jenniferfell commented on May 25, 2018

    @jenniferfell
    Contributor

    Rechecked against v6. Keeping open.

    @trotyl recommendation would be a useful clarification to help differentiate between "You import NgModule" (a proper noun) and "you import any ngModule" (kind of thing, which is the intent here).

    Recommendation copied here for convenience: "You also import NgModules (eg. BrowserModule) from Angular libraries using JavaScript import statements."

  6. 7 remaining items

  7. added a commit that references this issue on Jul 10, 2018
    8887d75
  8. added 2 commits that reference this issue on Jul 30, 2018
    5399c17
  9. angular-automatic-lock-bot commented on Sep 13, 2019

    @angular-automatic-lock-bot

    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.

  10. locked and limited conversation to collaborators on Sep 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions