Added Promises content in introduction & about #1397

codeiotic · 2021-10-03T06:04:05Z

junedev

Thanks a lot for working on this. I left a couple of minor comments.

junedev · 2021-10-03T12:37:30Z

concepts/promises/about.md

+});
+```
+
+## Methods


I would recommend to first show the instance methods and then the class methods and naming the headers accordingly. Also you can use h3 headings instead of bold text for the sub-sections. The structure could look like this:

## Instance Methods of a Promise ### then ### catch ### finally ## Static Methods of the Promise Class [here there should be some text with a link to all the other methods as we don't show all of them, https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise#static_methods] ### Promise.all ### Promise.reject ### Promise.resolve

junedev · 2021-10-03T12:43:39Z

concepts/promises/introduction.md

@@ -1,4 +1,104 @@
 # Introduction


The content of this file also needs to be copied to the introduction.md file of the translation service exercise: https://github.com/exercism/javascript/blob/main/exercises/concept/translation-service/.docs/introduction.md

junedev · 2021-10-03T12:46:03Z

concepts/promises/about.md

+
+When either of these options happens, the associated handlers queued up by a promise's `then` method is called. If the promise has already been fulfilled or rejected when a corresponding handler is attached, the handler will be called, so there is no race condition between an asynchronous operation completing and its handlers being attached.
+
+The methods [`promise.then()`][promise-then], [`promise.catch()`][promise-catch], and [`promise.finally()`][promise-finally] are used to associate further action with a promise that becomes settled.


This sentence can be removed as those methods are explained in detail below.

Should I also delete line number 11?

No, I think it is ok to keep it as general explanation.

junedev · 2021-10-03T13:46:22Z

concepts/promises/about.md

+A Promise is in one of these states:
+
+- **pending**: initial state, neither fulfilled nor rejected.
+- **fulfilled**: meaning that the operation was completed successfully.


Suggested change

- **fulfilled**: meaning that the operation was completed successfully.

- **fulfilled**: meaning that the operation was completed successfully and the result is available.

junedev · 2021-10-03T13:49:48Z

concepts/promises/about.md

 # About

-TODO: add information on promises concept
+The [Promise][promise-docs] object represents the eventual completion (or failure) of an asynchronous operation and its resulting value. It allows you to associate handlers with an asynchronous action's eventual success value or failure reason.


Links can be distracting so they should be used sparingly and only if they add additional value compared to the existing content. E.g. the link to the promise docs above could be placed in the links.json instead (if its not included already). It will then render below the content of this file in the "Read More" section.

There is already a link to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
Should I also add another link to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

Yes, I think they are different enough so that makes sense.

- Changed the ordering of methods - Fixed minor content issues

codeiotic · 2021-10-03T15:53:41Z

Anything more to add/change?

junedev · 2021-10-03T17:13:31Z

Well, there are probably always minor things that could be discussed/rephrased/changed. But the main thing I look for is that the proposed change is an improvement to what was there before (which this definitely is), that it is applied consistently across the different files (like with the exercise introduction) and whether there is something major that needs to be fixed the the headlines in this case.
Then the PR gets merged and of someone feels like improving the content further in the future there can be a new PR. This works better than turning around each sentence a couple of times.

codeiotic added 7 commits October 3, 2021 11:22

Added the content about Promises in about.md

a365069

Added content of Promises in introduction.md

45ff1fc

Ran prettier

afa309e

Added the About on the top

b645030

Ran prettier with proper config

4aa1eb9

This should work for about.md

84653c6

Update about.md

e55ebed

codeiotic changed the title ~~Added Promises content in introduction & about~~ [WIP] Added Promises content in introduction & about Oct 3, 2021

codeiotic marked this pull request as draft October 3, 2021 13:22

codeiotic added 2 commits October 3, 2021 19:01

Update introduction.md

7e761d9

Update about.md

bd39306

codeiotic marked this pull request as ready for review October 3, 2021 13:35

codeiotic changed the title ~~[WIP] Added Promises content in introduction & about~~ Added Promises content in introduction & about Oct 3, 2021

junedev reviewed Oct 3, 2021

View reviewed changes

codeiotic added 6 commits October 3, 2021 20:16

Update introduction.md

d125fe0

Removed an unnecessary sentence

7cde218

Update about.md

aad917f

- Changed the ordering of methods - Fixed minor content issues

Merge branch 'exercism:main' into main

521cf3c

Ran prettier

58362a8

Update links.json

80a9ce3

junedev approved these changes Oct 3, 2021

View reviewed changes

junedev merged commit ba70215 into exercism:main Oct 3, 2021

junedev added hacktoberfest-accepted Opt-in to hacktoberfest x:size/medium Medium amount of work labels Oct 3, 2021


		When either of these options happens, the associated handlers queued up by a promise's `then` method is called. If the promise has already been fulfilled or rejected when a corresponding handler is attached, the handler will be called, so there is no race condition between an asynchronous operation completing and its handlers being attached.

		The methods [`promise.then()`][promise-then], [`promise.catch()`][promise-catch], and [`promise.finally()`][promise-finally] are used to associate further action with a promise that becomes settled.

	- fulfilled: meaning that the operation was completed successfully.
	- fulfilled: meaning that the operation was completed successfully and the result is available.

Uh oh!

Added Promises content in introduction & about #1397

Added Promises content in introduction & about #1397

Uh oh!

Conversation

codeiotic commented Oct 3, 2021

Uh oh!

junedev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codeiotic commented Oct 3, 2021

Uh oh!

junedev commented Oct 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants