search

xKDR / TSFrames.jl

Timeseries in Julia
MIT License
91 stars 22 forks source link

Changing documentation to use the new `join` API. #129

Closed codetalker7 closed 1 year ago

codetalker7 commented 1 year ago

This PR addresses issue https://github.com/xKDR/TSFrames.jl/issues/125.

codecov-commenter commented 1 year ago

Codecov Report

Merging #129 (c195527) into main (c2078d0) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #129   +/-   ##
=======================================
  Coverage   89.80%   89.80%           
=======================================
  Files          19       19           
  Lines         363      363           
=======================================
  Hits          326      326           
  Misses         37       37
Impacted Files Coverage Δ
src/join.jl 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

chiraganand commented 1 year ago

@codetalker7 Can you also mention the method signature in the API docs? I should be able to see the keyword arguments, their default values, etc.

join(ts1::TSFrame, ts2::TSFrame, ts...; jointype::Symbol=:JoinAll)
codetalker7 commented 1 year ago

@codetalker7 Can you also mention the method signature in the API docs? I should be able to see the keyword arguments, their default values, etc.

join(ts1::TSFrame, ts2::TSFrame, ts...; jointype::Symbol=:JoinAll)

@chiraganand done.