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

docs: getting started guide use pipe before introduction #36584

Closed

Conversation

ajitsinghkaler
Copy link
Contributor

in getting started guide pipes are not intoduced anywhere but are used in guide added refrence to pipes for better consistency in the tutorial

Fixes #36375

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:

What is the current behavior?

Pipes used before it were referenced

Issue Number: #36375

What is the new behavior?

Pipes referenced on the first tutorial when they are used

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@pullapprove pullapprove bot requested a review from aikithoughts April 12, 2020 05:37
@gkalpak gkalpak added aio: preview comp: docs action: review The PR is still awaiting reviews from at least one requested reviewer target: patch This PR is targeted for the next patch release labels Apr 12, 2020
@ngbot ngbot bot added this to the needsTriage milestone Apr 12, 2020
@mary-poppins
Copy link

You can preview 18d35ef at https://pr36584-18d35ef.ngbuilds.io/.

1 similar comment
@mary-poppins
Copy link

You can preview 18d35ef at https://pr36584-18d35ef.ngbuilds.io/.

@ngbot ngbot bot modified the milestone: needsTriage Apr 12, 2020
Copy link
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

Thx, @ajitsinghkaler!

Please use proper sentences in the commit message to make it more readable (i.e. use capitalization, punctuation, etc.):

In "Getting started" guide pipes are not intoduced anywhere but are used in the guide.
Added refrence to pipes for better consistency in the tutorial.


<div class="alert is-helpful">

The operator `|` used for currency on product.price is called a pipe. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").
Copy link
Member

Choose a reason for hiding this comment

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

product.price --> `product.price`

Also, the sentence now makes it sound as if | is called a pipe (which it's not). We should re-phrase to make it clear that | is the "pipe operator" and currency is the pipe (which is not a great name, but that's what we gone with 🤷‍♂️).

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for this change! Here's a suggestion that I think might help. It puts more focus on the currency pipe than the operator, and provides a brief description of what a pipe is for.

Suggested change
The operator `|` used for currency on product.price is called a pipe. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").
The line, `<h4>{{ product.price | currency }}</h4>` uses the `currency` pipe to transform `product.price` from number to a currency string. A pipe is a way you can transform data in your HTML template. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").

Copy link
Contributor

@aikithoughts aikithoughts left a comment

Choose a reason for hiding this comment

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

Thanks for pointing this out! I offered a suggestion. Let me know what you think.


<div class="alert is-helpful">

The operator `|` used for currency on product.price is called a pipe. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for this change! Here's a suggestion that I think might help. It puts more focus on the currency pipe than the operator, and provides a brief description of what a pipe is for.

Suggested change
The operator `|` used for currency on product.price is called a pipe. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").
The line, `<h4>{{ product.price | currency }}</h4>` uses the `currency` pipe to transform `product.price` from number to a currency string. A pipe is a way you can transform data in your HTML template. For more information about Angular pipes, see [Pipes](guide/pipes "Pipes").

In "Getting started" guide pipes are not intoduced anywhere but are used in the guide.
Added refrence to pipes for better consistency in the tutorial.

Fixes angular#36375
@ajitsinghkaler
Copy link
Contributor Author

@aikidave @gkalpak made the changes please have a look

@mary-poppins
Copy link

You can preview c8252e9 at https://pr36584-c8252e9.ngbuilds.io/.

Co-Authored-By: David Shevitz <dshevitz@google.com>
@mary-poppins
Copy link

You can preview e678339 at https://pr36584-e678339.ngbuilds.io/.

@ajitsinghkaler
Copy link
Contributor Author

@aikidave @gkalpak made the change please have a look

@gkalpak gkalpak removed their request for review April 16, 2020 10:52
@ajitsinghkaler
Copy link
Contributor Author

ajitsinghkaler commented Apr 16, 2020

@aikidave can you please add the merge label

@aikithoughts aikithoughts added the action: merge The PR is ready for merge by the caretaker label Apr 16, 2020
@matsko matsko removed the action: review The PR is still awaiting reviews from at least one requested reviewer label Apr 16, 2020
matsko pushed a commit that referenced this pull request Apr 16, 2020
In "Getting started" guide pipes are not intoduced anywhere but are used in the guide.
Added refrence to pipes for better consistency in the tutorial.

Fixes #36375

PR Close #36584
@matsko matsko closed this in 1fa1dd5 Apr 16, 2020
@ajitsinghkaler ajitsinghkaler deleted the managing-data-pipes branch April 17, 2020 00:44
@angular-automatic-lock-bot
Copy link

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 May 18, 2020
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 aio: preview 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.

Mention pipes in Managing Data
6 participants