Skip to content

/angular

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

Jump to bottom

A mistake in the docs - in the description of the Component Class section #32948

Closed
fouaddev opened this issue Oct 2, 2019 · 8 comments
Closed

A mistake in the docs - in the description of the Component Class section #32948

fouaddev opened this issue Oct 2, 2019 · 8 comments
Labels
comp: docs comp: docs-infra freq1: low good first issue severity1: confusing type: bug/fix
Projects
docs
Milestone
Backlog

Comments

@fouaddev
Copy link

@fouaddev fouaddev commented Oct 2, 2019 •
edited

📚 Docs or angular.io bug report

Description

In the Component Class section, the reference of angular in relation to typescript should be angular instead of angularJS.

🔬 Minimal Reproduction

What's the affected URL?**

https://angular.io/guide/ajs-quick-reference

Reproduction Steps**

Go to the link above and scroll down to the Component class section. Read its description.

Expected vs Actual Behavior**

Expected:

NOTE: If you are using TypeScript with Angular, you must use the export keyword to export the component class.

Actual Behavior:

NOTE: If you are using TypeScript with AngularJS, you must use the export keyword to export the component class.

📷Screenshot

angular_mistake

🔥 Exception or Error

🌍 Your Environment

Browser info

Version 77.0.3865.90 (Official Build) (64-bit)

Anything else relevant?

This is just a text mistake in the docs, not a code error.
@fouaddev fouaddev changed the title A mistake in the Component Class section description A mistake in the docs in the Component Class section description Oct 2, 2019
@fouaddev fouaddev changed the title A mistake in the docs in the Component Class section description A mistake in the docs in the description of the Component Class section Oct 2, 2019
@fouaddev fouaddev changed the title A mistake in the docs in the description of the Component Class section A mistake in the docs - in the description of the Component Class section Oct 2, 2019
@ngbot ngbot bot modified the milestone: needsTriage Oct 2, 2019
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Oct 2, 2019
@kapunahelewong kapunahelewong added this to Pending - Top of backlog in docs Oct 2, 2019
@ODAVING

This comment has been minimized.

Sign in to view
Copy link
Contributor

@ODAVING ODAVING commented Oct 2, 2019

Hello,
I'm fairly new to the open source community! however, I've made a PR for this issue, please let me know if there are any changes that need to be done.

Additionally, the form the PR has me fill out is a bit confusing, so I'd appreciate some insight in that as well.
Thanks!
@fouaddev

This comment has been minimized.

Sign in to view
Copy link
Author

@fouaddev fouaddev commented Oct 2, 2019

Hey ODAVING, me too, this is my first issue that I opened for Angular :) Loving it so far. As for the PR, yeah It can be a bit confusing but just follow the steps one by one. There are many blog posts on how to do it. Just google it.
@olierxleben

This comment has been minimized.

Sign in to view
Copy link

@olierxleben olierxleben commented Oct 2, 2019

should have "has PR" tag! Just wanted to jump in. lol
@ODAVING

This comment has been minimized.

Sign in to view
Copy link
Contributor

@ODAVING ODAVING commented Oct 2, 2019

@fouaddev That's amazing! I think I managed to do everything they suggested, so I guess we just have to wait until PR is reviewed. I'm loving open source as well as the community!
@YuliaTsareva

This comment has been minimized.

Sign in to view
Copy link
Contributor

@YuliaTsareva YuliaTsareva commented Oct 2, 2019

@ODAVING I would advise to add footer with "Closes #issue_number" text to commit message next time :) In that case, the issue and your PR will be linked automatically. So it will be easier to track PRs even before the label "has PR" is added.
@ODAVING

This comment has been minimized.

Sign in to view
Copy link
Contributor

@ODAVING ODAVING commented Oct 3, 2019

@YuliaTsareva Really appreciate the advice Yulia, will keep that in-mind for next time!
@fouaddev

This comment has been minimized.

Sign in to view
Copy link
Author

@fouaddev fouaddev commented Oct 4, 2019

I was wondering how long does it usually take to resolve a doc issue like this one?
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 7, 2019
@ODAVING
docs(*): fix a mistake in the docs
3c7ccee 
change component class section of the docs to be less confusing

Closes angular#32948
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 8, 2019
@ODAVING
docs(*): spelling error in angular component
facb6c7 
change component class section of the docs

Closes angular#32948

docs(*): fix a mistake in the docs

change component class section of the docs to be less confusing

Closes angular#32948

docs(*): fix a mistake in the docs

change component class section of the docs to be less confusing

Closes angular#32948
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 8, 2019
@ODAVING
docs(common): spelling error in angular component
1899328 
change component class section of the docs

Closes angular#32948

docs(common): fix a mistake in the docs

change component class section of the docs to be less confusing

Closes angular#32948
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 18, 2019
@ODAVING
Merge branch 'master' of https://github.com/angular/angular into angu…
63738d3 
…lar#32948
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 18, 2019
@ODAVING
Merge branch 'angular#32948' of https://github.com/ODAVING/angular into
d02d5cf 
angular#32948
ODAVING added a commit to ODAVING/angular that referenced this issue Oct 18, 2019
@ODAVING
Merge branch 'angular#32948' of https://github.com/ODAVING/angular into
0b9d693 
angular#32948
kapunahelewong added a commit to ODAVING/angular that referenced this issue Oct 23, 2019
@ODAVING @kapunahelewong
docs(common): spelling error in angular component
ba8274d 
change component class section of the docs

Closes angular#32948

docs(common): fix a mistake in the docs

change component class section of the docs to be less confusing

Closes angular#32948
kapunahelewong added a commit to ODAVING/angular that referenced this issue Oct 23, 2019
@ODAVING @kapunahelewong
docs: fix spelling error in angular component
d09f6c4 
change component class section of the docs

Closes angular#32948
AndrewKushnir added a commit that referenced this issue Oct 23, 2019
@ODAVING @AndrewKushnir
docs: fix spelling error in angular component (#32971)
Loading status checks…
70238f7 
change component class section of the docs

Closes #32948

PR Close #32971
@jbogarthyde jbogarthyde moved this from Pending - Top of backlog to Done in docs Oct 29, 2019
@angular-automatic-lock-bot

This comment has been minimized.

Sign in to view
Copy link

@angular-automatic-lock-bot angular-automatic-lock-bot bot commented Nov 23, 2019

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 Nov 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
comp: docs comp: docs-infra freq1: low good first issue severity1: confusing type: bug/fix
Projects
docs
Done
Milestone
  Backlog
6 participants
@fouaddev @ODAVING @olierxleben @YuliaTsareva @atscott @kapunahelewong
You can’t perform that action at this time.