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

Address ID review items #28

Merged
merged 2 commits into from
Jun 19, 2019
Merged

Conversation

realModusOperandi
Copy link
Contributor

@realModusOperandi realModusOperandi commented Jun 17, 2019

Addressing comments in #27.

Questions: 1) Are async and await different features? That’s how I read it, so I updated the subject/verb agreement to be in line with my assumption. 2) What needs to be compatible with the features in, “To be compatible with these features,…”? I would like to update this to, “For ___ to be compatible with these features,…”.

  1. They are the same feature, usually written as "async/await" so I updated to use that terminology and keep it as one noun.
  2. The result of the HttpClient.get() call is what needs to be made compatible by invoking toPromise() on it, so I revised to say that.

Question: Do my updates look correct here? Is the lifecycle hook the “specific function” or the “component” mentioned in the sentence? I updated it so that it reads that the lifecycle hook is the function.

Yes these are correct.

Question: What are div and *ngFor (in terms of providing a noun after each)? The “the ___ {noun}” structure can make sentences more clear for users.

div is an element. *ngFor is a directive:

Now use the Angular ngFor directive in the template to display each item in the heroes list.

I've updated to use those terms in the format you requested.

@realModusOperandi realModusOperandi self-assigned this Jun 17, 2019
Copy link

@Charlotte-Holt Charlotte-Holt left a comment

Choose a reason for hiding this comment

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

@evelinec @realModusOperandi I made just a few small suggestions. Let me know if you have any questions. Thanks!

README.adoc Outdated
the entire application. A good service performs only one function and does it well. In
this case, `ArtistsService` will handle requesting artists data from the REST
service.
entire applications. A good service performs only one function and it performs this

Choose a reason for hiding this comment

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

Change
"A good service performs only one function and it performs this function well."
to
"A good service performs only one function, and it performs this function well."

README.adoc Outdated
must be converted to a Promise using [hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]`toPromise()`. A Promise is how
JavaScript represents the state of an asynchronous operation. If you want to learn
more, check out https://promisejs.org[^] for an introduction.
Create the entire [hotspot=artistsServiceClass]`ArtistsService` class with the [hotspot=atInjectable]`@Injectable` annotation. Add the

Choose a reason for hiding this comment

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

Check to make sure there isn't an extra space between "the" and "[hotspot=atInjectable]@Injectable"

README.adoc Outdated
[hotspot=importHttpClient]`HttpClient` and [hotspot=importInjectable]`Injectable`
import statements at the top.

The file imports the [hotspot=importHttpClient]`HttpClient` class and

Choose a reason for hiding this comment

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

Change
"The file imports the [hotspot=importHttpClient]HttpClient class and
[hotspot=importInjectable]Injectable decorator."
to
"The file imports the [hotspot=importHttpClient]HttpClient class and the [hotspot=importInjectable]Injectable decorator."

the result of the
[hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]`HttpClient.get()` method to
be compatible with this feature, it must be converted to a Promise invoking its
[hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]`toPromise()` method. A

Choose a reason for hiding this comment

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

Change
"For the result of the [hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]HttpClient.get() method to be compatible with this feature, it must be converted to a Promise invoking its [hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]toPromise() method."
to
"For the result of the [hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]HttpClient.get() method to be compatible with this feature, it must be converted to a Promise by invoking its [hotspot=httpInstanceAndAwaitFeatureAndHttpGetAndToPromise]toPromise() method."

component so the component can run code in response to this event. This component
responds to the [hotspot=onInitInterface]`OnInit` event via the
[hotspot=ngOnInitMethod]`ngOnInit` method which fetches and populates the component's
template with data when it is initialized for display. The file imports the

Choose a reason for hiding this comment

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

Change
"This component responds to the [hotspot=onInitInterface]OnInit event via the [hotspot=ngOnInitMethod]ngOnInit method which fetches and populates the component's template with data when it is initialized for display."
to
"This component responds to the [hotspot=onInitInterface]OnInit event via the [hotspot=ngOnInitMethod]ngOnInit method, which fetches and populates the component's template with data when it is initialized for display."

@realModusOperandi
Copy link
Contributor Author

Ok, made the requested changes (and reformatted a line I missed.)

Copy link

@Charlotte-Holt Charlotte-Holt left a comment

Choose a reason for hiding this comment

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

@realModusOperandi Looks good. Thanks, Liam. Approved from an ID perspective.

Copy link
Contributor

@evelinec evelinec left a comment

Choose a reason for hiding this comment

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

Looks good. Will refresh the staging site to proceed with the final testing.

@evelinec evelinec merged commit 43c202e into OpenLiberty:dev Jun 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants