[v2] Add documentation for async middleware and App#processEvent #381

barlock · 2020-01-24T17:01:53Z

Summary

Adds documentation for code in PR: #375 and #380

Depends on #369

Important notes

My Japanese is bad. Perhaps non-existant? Honestly the only language I know how to speak is ecmascript 🤷‍♂.

Should someone make a PR to my PR with JP edits? I'll try and notate where they need to happen.

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2020-01-24T17:06:22Z

Codecov Report

Merging #381 into @slack/bolt@next will increase coverage by 2.03%.
The diff coverage is n/a.

@@                 Coverage Diff                 @@
##           @slack/bolt@next    #381      +/-   ##
===================================================
+ Coverage             83.56%   85.6%   +2.03%     
===================================================
  Files                     7       7              
  Lines                   505     514       +9     
  Branches                145     149       +4     
===================================================
+ Hits                    422     440      +18     
+ Misses                   54      50       -4     
+ Partials                 29      24       -5

Impacted Files	Coverage Δ
src/ExpressReceiver.ts	`71% <0%> (-1.39%)`	⬇️
src/middleware/builtin.ts	`82.2% <0%> (-0.2%)`	⬇️
src/App.ts	`90.25% <0%> (+2.9%)`	⬆️
src/middleware/process.ts	`100% <0%> (+12.5%)`	⬆️
src/errors.ts	`93.93% <0%> (+12.68%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5881471...95cb527. Read the comment docs.

seratch · 2020-01-24T17:15:22Z

@barlock
Thanks for your attention to the documents! Also, as a native Japanese speaker, I really appreciate your efforts on Japanese ones as well and I don't see any issues with the changes so far. So, regarding this PR, we can go with your changes as-is.

Should someone make a PR to my PR with JP edits? I'll try and notate where they need to happen.

If a PR requires updates to not only code snippets but sentences (like this), I usually work on it. 💪

docs/_advanced/ja_middleware_global.md

docs/_advanced/ja_middleware_listener.md

docs/_advanced/ja_receiver.md

docs/_advanced/ja_context.md

docs/_tutorials/ja_hubot_migration.md

barlock · 2020-02-03T17:32:00Z

Updated to be based on @slack/bolt@next and updated the commits. This is ready to be reviewed/merged now.

seratch · 2020-02-04T04:57:13Z

@aoberoi This PR even including the Japanese ones looks great to me. I think we can merge this one now.
@shaydewael I know you're busy but if you have a chance to take a look at this, that'll be really helpful as this one is about the docs. 🙏

stevengill

Looks great! Just some small feedback

README.md

stevengill · 2020-03-18T20:54:48Z

docs/_advanced/ja_receiver.md

@@ -40,6 +40,10 @@ class simpleReceiver extends EventEmitter {
      this.app.post(endpoint, this.requestHandler.bind(this));
    }
  }
+


Line 31-33 still extends EventEmitter

README.md

aoberoi

I'm glad this has already merged, but I just wanted to take some notes regarding a few things I noticed. I will likely follow up with another PR to address these comments.

README.md

docs/_advanced/middleware_global.md

docs/_advanced/receiver.md

barlock changed the title ~~Promise docs~~ Add documentation for async middleware and App#processEvent Jan 24, 2020