tumblr / colossus

I/O and Microservice library for Scala
Apache License 2.0
1.14k stars 96 forks source link

Cleanup scaladocs #573

Closed daniellacosse closed 7 years ago

daniellacosse commented 7 years ago

Meant to help address issue https://github.com/tumblr/colossus/issues/417

Fills in a lot of the missing parameter descriptions, name mismatches, etc.

@benblack86 @aliyakamercan

nsauro commented 7 years ago

I saw some typo's in RetryPolicy's docs as well :-p.

codecov-io commented 7 years ago

Codecov Report

Merging #573 into develop will increase coverage by 0.38%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           develop    #573      +/-   ##
==========================================
+ Coverage    84.52%   84.9%   +0.38%     
==========================================
  Files           99      99              
  Lines         4432    4431       -1     
  Branches       357     356       -1     
==========================================
+ Hits          3746    3762      +16     
+ Misses         686     669      -17
Impacted Files Coverage Δ
...s/src/main/scala/colossus/metrics/Collection.scala 97.43% <ø> (ø) :arrow_up:
...cala/colossus/protocols/memcache/MemcacheOps.scala 76.31% <ø> (ø) :arrow_up:
...main/scala/colossus/protocols/redis/RedisOps.scala 92.94% <ø> (ø) :arrow_up:
...sus/src/main/scala/colossus/streaming/Source.scala 84.72% <ø> (ø) :arrow_up:
...src/main/scala/colossus/metrics/MetricSystem.scala 93.18% <ø> (+2.27%) :arrow_up:
...rc/main/scala/colossus/core/server/ServerDSL.scala 85.71% <ø> (ø) :arrow_up:
...src/main/scala/colossus/metrics/StatReporter.scala 73.91% <ø> (ø) :arrow_up:
...ossus/src/main/scala/colossus/core/ServerRef.scala 83.33% <ø> (ø) :arrow_up:
...s/src/main/scala/colossus/core/server/Server.scala 94.44% <0%> (-0.63%) :arrow_down:
...s/src/main/scala/colossus/service/ServiceDSL.scala 85.41% <0%> (ø) :arrow_up:
... and 16 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 1428f14...704d5cf. Read the comment docs.