Skip to content

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

Closed
ejcheng wants to merge 3 commits into
angular:masterfrom
ejcheng:master
Closed

ejcheng wants to merge 3 commits into
angular:masterfrom
ejcheng:master

Conversation

@ejcheng

@ejcheng ejcheng commented Oct 2, 2021

Copy link
Copy Markdown
Contributor

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 October 2, 2021 19:52
changed second big block of comments to use multi-line comment structure instead of multiple single-line comments

@petebacondarwin petebacondarwin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 The PR is still awaiting reviews from at least one requested reviewer comp: docs target: patch This PR is targeted for the next patch release labels Oct 3, 2021
@ngbot ngbot Bot modified the milestone: Backlog Oct 3, 2021
@ejcheng

ejcheng commented Oct 3, 2021

Copy link
Copy Markdown
Contributor Author

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! :)

@ejcheng ejcheng 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

@devversion devversion left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@devversion
devversion removed the request for review from alxhub October 21, 2021 17:54
@devversion devversion added action: merge The PR is ready for merge by the caretaker action: presubmit The PR is in need of a google3 presubmit and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Oct 21, 2021
@jessicajaniuk jessicajaniuk removed the action: presubmit The PR is in need of a google3 presubmit label Oct 21, 2021
@jessicajaniuk

Copy link
Copy Markdown
Contributor

This PR was merged into the repository by commit b1c0286.

jessicajaniuk pushed a commit that referenced this pull request 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 pull request 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 pull request 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
Copy Markdown

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 pull request Jan 20, 2022
Serginho pushed a commit to TuLotero/angular that referenced this pull request Jan 20, 2022
Serginho pushed a commit to TuLotero/angular that referenced this pull request 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 The PR is ready for merge by the caretaker cla: yes target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants