pksprojects / ElasticSwift

Elasticsearch client in swift
MIT License
46 stars 18 forks source link

[chore] add basic docs for ElasticSwift #64

Closed prafsoni closed 4 years ago

prafsoni commented 4 years ago

[chore] add basic docs for ElasticClient, IndicesClient, ClusterClient, responses, response converters, serializer and utils.

codecov[bot] commented 4 years ago

Codecov Report

Merging #64 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #64   +/-   ##
=======================================
  Coverage   38.75%   38.75%           
=======================================
  Files          53       53           
  Lines        5638     5638           
=======================================
  Hits         2185     2185           
  Misses       3453     3453
Impacted Files Coverage Δ
...ces/ElasticSwift/Serialization/Serialization.swift 100% <ø> (ø) :arrow_up:
Sources/ElasticSwift/Clients/Indices.swift 40% <ø> (ø) :arrow_up:
...lasticSwift/Serialization/ResponseConverters.swift 71.87% <ø> (ø) :arrow_up:
Sources/ElasticSwift/Clients/Clusters.swift 100% <ø> (ø) :arrow_up:
...urces/ElasticSwift/Responses/IndicesResponse.swift 28.91% <ø> (ø) :arrow_up:
Sources/ElasticSwift/ElasticSwift.swift 52% <ø> (ø) :arrow_up:
Sources/ElasticSwift/Utils/Utils.swift 28.57% <ø> (ø) :arrow_up:
Sources/ElasticSwift/Responses/Response.swift 80.7% <ø> (ø) :arrow_up:

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 c87a712...82af3c1. Read the comment docs.