These are chat archives for azu/promises-book

12th
Aug 2016
harry
@harry0000
Aug 12 2016 11:56

Promise本、ES2015で写経しながら勉強させていただきました。とても良い本ですね。

読後、職業柄いくつか気になった点がありましたので、この場にて報告させていただきます。
2年以上前からあるドキュメントに指摘をするのも野暮で多少の申し訳なさもありますが…

  • console.error(error) vs console.log(error)

一部 console.log(error) となっている所があるようです。
grepして洗い出してみました。

直した方がよさそうな所とそうでもない所があったため、PRは出しませんでした。

promises-book\Ch1_WhatsPromises\promise-overview.adoc(87):     console.log(error);
promises-book\Ch1_WhatsPromises\src\promise-workflow.js(14):     console.log(error);
promises-book\Ch2_HowToWrite\promise-all.adoc(23):     console.log(error);
promises-book\Ch2_HowToWrite\promise-then.adoc(17):     console.log(error);
promises-book\Ch2_HowToWrite\src\promise-then-catch-flow.js(8):     console.log("Catch Error: A or B", error);
promises-book\Ch2_HowToWrite\src\promise-then-taska-throw.js(9):     console.log(error);// => "throw Error @ Task A"
promises-book\Ch2_HowToWrite\test\then-return-new-promise-test.js(12):             console.log(error);
promises-book\Ch4_AdvancedPromises\race-delay-timeout.adoc(82):     console.log("タイムアウトになってしまった", error);
promises-book\Ch4_AdvancedPromises\race-delay-timeout.adoc(133):     console.log(error instanceof TimeoutError);// true
promises-book\Ch4_AdvancedPromises\src\grouping-promises.js(46):             console.log(error);
promises-book\Ch4_AdvancedPromises\src\grouping-promises.js(49):         console.log("XHR Error :", error);
promises-book\Ch4_AdvancedPromises\src\race-delay-timeout\delay-race-cancel-play.js(13):             console.log(error);
promises-book\Ch4_AdvancedPromises\src\race-delay-timeout\delay-race-cancel-play.js(16):         console.log("XHR Error :", error);
  • 見ていく vs 見て行く
補助動詞の「いく」は平仮名で統一した方がよさそうです。
promises-book\Appendix-Glossary\about-author.adoc(24): メッセージを残すついでにダウンロードして行ってください。
promises-book\Appendix-Note\beginning-story.adoc(111): 作業も一つのセクションと一つのpull-requestを対応させて行った方が管理しやすいと気付きました。
promises-book\Appendix-Note\beginning-story.adoc(122): 最低限おかしなところは直さないと行けないため、文章をひと通り書き終わってから誤字などチェックを始めました。
promises-book\Ch1_WhatsPromises\writing-promises.adoc(52): 次に、`reject` の方を見て行きましょう。
promises-book\Ch1_WhatsPromises\writing-promises.adoc(152): 次の章では、Promiseのメリットであるエラーハンドリングの仕組みをコールバックベースの実装と比較しながら見て行きたいと思います。
promises-book\Ch2_HowToWrite\promise-then.adoc(33): それぞれのpromiseオブジェクトに登録された onFulfilledとonRejectedがどのように呼ばれるかを見て行きましょう。
promises-book\Ch3_Testing\mocha-promise.adoc(12): では、実際にどのように書くかの例を見て行きたいと思います。
promises-book\Ch3_Testing\mocha-promise.adoc(193): もう少し分かりやすいテストを書くにはどうするべきかについて見て行きましょう。
promises-book\Ch3_Testing\readme.adoc(5): この章ではPromiseのテストの書き方について学んで行きます。
promises-book\Ch4_AdvancedPromises\promise-sequence.adoc(13): このセクションでは、Promiseを使った逐次処理の書き方について学んで行きたいと思います。
promises-book\Ch4_AdvancedPromises\race-delay-timeout.adoc(13): まずはタイムアウトをPromiseでどう実現するかを見て行きたいと思います。
  • 細かい文章表現

promises-book\Ch1_WhatsPromises\promise-overview.adoc(93)

「少し~、少し」と続いてしまってますが、「Promiseの状態」についてはここで詳細に解説されており、
これ以降に「Promiseの状態」の章は登場しませんので、2つ目の「少し」は取ってしまってよいと思います。

Promiseの処理の流れが少しわかった所で、少しPromiseの状態について整理したいと思います。

promises-book\Ch3_Testing\basic-tests.adoc(164)

「"Promisesのテスト"をサポートしているという事がどういう機能なのか」が
「いう~いう」となっていることもあり、少し読みづらい感じがあります。
「のサポートがどういう機能であるか」とするとよさそうです。

また「どういう」は「どのような」と変えた方が丁寧な印象がありますが、
全体的に前者の表現が使用されていますので、そのままでもよいと思います。

次に、最初にmochaを使う理由に上げた"Promisesのテスト"をサポートしているという事がどういう機能なのかを学んでいきましょう。
次に、最初にmochaを使う理由に上げた"Promisesのテスト"のサポートがどういう機能であるか学んでいきましょう。

promises-book\Ch4_AdvancedPromises\race-delay-timeout.adoc(200)

「ので、」の収束でつながっているので、そのまま「以下のように」とつなげた方が文章がすっきりする気がします。

一つの関数で全てやろうとしてるのがそもそも良くないので、
ひとつの関数で何でもやるのは止めて、以下のように関数に分離していくというのが妥当な気がします。
一つの関数で全てやろうとしてるのがそもそも良くないので、
以下のように関数に分離していくというのが妥当な気がします。
以上です。
指摘すること自体が恥ずかしくなるようなものは除きました。何かのお役に立てば幸いです。
ありがとうございます。
Issueを立ててもらっても問題なかったですが、後でIssue立てて修正してみます。
textlint作る前に書いた文章なので、表記揺れが目視チェックでやっぱり揺れてる感じですね。
File issue:
azu/promises-book#266
azu/promises-book#267
azu/promises-book#268
azu/promises-book#269
azu/promises-book#270
指摘箇所を修正するPR: azu/promises-book#271
@harry0000 ありがとうございます。
ご指摘頂いた箇所を修正致しました 。
https://github.com/azu/promises-book/releases/tag/1.6.1
harry
@harry0000
Aug 12 2016 13:13
お手数おかけし恐縮です。
:thumbsup: