Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs(uppercase): Added an example #15885

Merged
merged 4 commits into from
Apr 7, 2017
Merged

docs(uppercase): Added an example #15885

merged 4 commits into from
Apr 7, 2017

Conversation

snood1205
Copy link
Contributor

@snood1205 snood1205 commented Apr 3, 2017 •
edited
Loading

I saw that the uppercase filter had no example so I decided to add a minimal example to explain how the uppercase filter works.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Docs update.

What is the current behavior? (You can also link to an open issue here)
There is currently no example for the uppercase filter, so I added one.

What is the new behavior (if this is a feature change)?
N/a

Does this PR introduce a breaking change?
No.

Please check if the PR fulfills these requirements

Other information:

@snood1205
docs(uppercase): Added an example
faeeac5 
I saw that the uppercase filter had no example so I decided to add a minimal example to explain how the uppercase filter works.
@Narretz
Copy link
Contributor

Narretz commented Apr 5, 2017

Thanks for the PR! Can you please make these 2 changes:

  • remove the protractor test (it's a very simple test, and we run these tests for every build, so it adds up)
  • add a link to the uppercase filter that you can find an example in the lowercase filter docs?

@Narretz Narretz added this to the Backlog milestone Apr 5, 2017
@snood1205
Copy link
Contributor Author

I remove the protractor file and added @see angular.uppercase to the docs for lowercase.

@snood1205
Copy link
Contributor Author

@Narretz is this appropriate on the whole or would you like me to change this?

Narretz
Narretz suggested changes Apr 7, 2017
View reviewed changes
src/ng/filter/filters.js Outdated
@@ -709,6 +710,22 @@ var lowercaseFilter = valueFn(lowercase);
* @kind function
* @description
* Converts string to uppercase.
* @see angular.uppercase
* @example
<example name="filter-uppercase">
Copy link
Contributor

Choose a reason for hiding this comment

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

you must add module=uppercaseFilterExample, otherwise the example won't work

src/ng/filter/filters.js Outdated
@@ -699,6 +699,7 @@ function jsonFilter() {
* @description
* Converts string to lowercase.
* @see angular.lowercase
* @see angular.uppercase
Copy link
Contributor

Choose a reason for hiding this comment

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

The docs don't actually do anything with @see :(, please revert this change

src/ng/filter/filters.js
@@ -699,6 +699,7 @@ function jsonFilter() {
* @description
* Converts string to lowercase.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a link after this that points to uppercase: Format is {@link ng.filter.uppercase linktext}

snood1205 and others added 2 commits April 7, 2017 10:04
@snood1205
I believe that the changes made now fully comply with @Narretz's reco…
afa3450 
…mmendations

Thank you very much to @Narretz for helping me through this process
@Narretz
Fix link
82034c2
@googlebot
Copy link

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

1 similar comment
@googlebot
Copy link

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

@googlebot googlebot added cla: no and removed cla: yes labels Apr 7, 2017
@Narretz
Copy link
Contributor

Narretz commented Apr 7, 2017

Thanks - I fixed the link myself because I gave you the wrong path ;)

@Narretz Narretz merged commit e812b9f into angular:master Apr 7, 2017
Narretz pushed a commit that referenced this pull request Apr 21, 2017
@snood1205 @Narretz
docs(filter/uppercase): add an example
9f30bb5 
I saw that the uppercase filter had no example so I decided to add a minimal example to explain how the uppercase filter works.

Thank you very much to @Narretz for helping me through this process.

Closes #15885
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Narretz Narretz Narretz requested changes

Assignees
No one assigned
Labels
cla: no component: filters type: docs
Projects
None yet
Milestone
Backlog - won't fix
Development

Successfully merging this pull request may close these issues.
3 participants
@snood1205 @Narretz @googlebot