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

refactor: make comment structure consistent in packages/core/index.ts, fix minor grammar mistakes in documentation #43684

Closed
wants to merge 3 commits into from

Conversation

import-brain
Copy link
Contributor

@import-brain import-brain commented Oct 2, 2021

Fixed second big blob of comments in packages/core/index.ts to use multiline comments
Fixed grammar mistakes in documentation throughout project

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

@google-cla google-cla bot added the cla: yes label Oct 2, 2021
@pullapprove pullapprove bot requested review from alxhub and devversion Oct 2, 2021
changed second big block of comments to use multi-line comment structure instead of multiple single-line comments
Copy link
Member

@petebacondarwin petebacondarwin left a comment

Thanks @import-brain for helping to make our docs better

I'm approving this but in general it would be great if PRs contains more significant improvements. Mostly, these additional commas are subjective and stylistic and one could argue they are not really needed.

One further thing to note for future changes. To strictly follow out guidelines, the commit message header should be in present tense rather than past. E.g. docs: fix minor grammar mistakes in CONTRIBUTING.

Reviewed-for: global-docs-approvers

@petebacondarwin petebacondarwin added action: review comp: docs target: patch labels Oct 3, 2021
@ngbot ngbot bot added this to the Backlog milestone Oct 3, 2021
@ngbot ngbot bot added this to the Backlog milestone Oct 3, 2021
@ngbot ngbot bot added this to the Backlog milestone Oct 3, 2021
@import-brain
Copy link
Contributor Author

@import-brain import-brain commented Oct 3, 2021

Thanks @import-brain for helping to make our docs better

I'm approving this but in general it would be great if PRs contains more significant improvements. Mostly, these additional commas are subjective and stylistic and one could argue they are not really needed.

One further thing to note for future changes. To strictly follow out guidelines, the commit message header should be in present tense rather than past. E.g. docs: fix minor grammar mistakes in CONTRIBUTING.

Reviewed-for: global-docs-approvers

@petebacondarwin Ah I see, thanks for the help! I'll try to make more significant improvements next time, and thanks for informing me about the present tense rule, I didn't realize that! :)

@import-brain import-brain changed the title refactor: made comment structure consistent in packages/core/index.ts, fixed minor grammar mistakes in documentation refactor: make comment structure consistent in packages/core/index.ts, fix minor grammar mistakes in documentation Oct 4, 2021
Copy link
Member

@devversion devversion left a comment

LGTM

@devversion devversion removed the request for review from alxhub Oct 21, 2021
@devversion devversion added action: merge action: presubmit and removed action: review labels Oct 21, 2021
@jessicajaniuk jessicajaniuk removed the action: presubmit label Oct 21, 2021
@jessicajaniuk
Copy link
Contributor

@jessicajaniuk jessicajaniuk commented Oct 21, 2021

This PR was merged into the repository by commit b1c0286.

jessicajaniuk pushed a commit that referenced this issue Oct 21, 2021
changed second big block of comments to use multi-line comment structure instead of multiple single-line comments

PR Close #43684
jessicajaniuk pushed a commit that referenced this issue Oct 21, 2021
changed second big block of comments to use multi-line comment structure instead of multiple single-line comments

PR Close #43684
jessicajaniuk pushed a commit that referenced this issue Oct 21, 2021
changed second big block of comments to use multi-line comment structure instead of multiple single-line comments

PR Close #43684
@angular-automatic-lock-bot
Copy link

@angular-automatic-lock-bot angular-automatic-lock-bot bot commented Nov 21, 2021

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 21, 2021
Serginho pushed a commit to TuLotero/angular that referenced this issue Jan 20, 2022
Serginho pushed a commit to TuLotero/angular that referenced this issue Jan 20, 2022
Serginho pushed a commit to TuLotero/angular that referenced this issue Jan 20, 2022
…r#43684)

changed second big block of comments to use multi-line comment structure instead of multiple single-line comments

PR Close angular#43684
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge cla: yes comp: docs target: patch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants