search

olistic / warriorjs

🏰 An exciting game of programming and Artificial Intelligence
https://warriorjs.com
MIT License
9.41k stars 488 forks source link

Improve ability documentation #244

Open Zarel opened 5 years ago

Zarel commented 5 years ago

The warrior object isn't actually documented outside of the auto-generated README, so the auto-generated README could stand to be a bit more specific than it currently is.

Abilities now document arguments, and contain some other relevant information previously only found in tips.

codecov[bot] commented 5 years ago

Codecov Report

Merging #244 into master will increase coverage by 0.28%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #244      +/-   ##
==========================================
+ Coverage   92.39%   92.68%   +0.28%     
==========================================
  Files          92       93       +1     
  Lines        1091     1093       +2     
  Branches      165      165              
==========================================
+ Hits         1008     1013       +5     
+ Misses         68       65       -3     
  Partials       15       15
Impacted Files Coverage Ξ”
packages/warriorjs-abilities/src/bind.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/rescue.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/shoot.js 100% <ΓΈ> (ΓΈ) :arrow_up:
...kages/warriorjs-abilities/src/directionOfStairs.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/listen.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/pivot.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/directionOf.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/detonate.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/feel.js 100% <ΓΈ> (ΓΈ) :arrow_up:
packages/warriorjs-abilities/src/rest.js 100% <ΓΈ> (ΓΈ) :arrow_up:
... and 22 more

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 97bac9f...16369b7. Read the comment docs.

olistic commented 5 years ago

Hello @Zarel, just wanted to thank you for your contribution, and let you know that it didn't go by unnoticed. I'll be a bit busy for a couple more days, and then I'll review this.

Zarel commented 5 years ago

Heya, just poking to make sure you didn't forget.