ReSwift-Router icon indicating copy to clipboard operation
ReSwift-Router copied to clipboard

Update Documentation for Routable Protocol

Open viewDidAppear opened this issue 7 years ago • 3 comments

This change has been made to take advantage of the /// header-doc functionality in Xcode. Holding down Option while clicking on the method signatures of the Routable protocol will now provide further insight as to what needs to be supplied, and how it must be implemented to ensure fatalError() does not get triggered at runtime.

viewDidAppear avatar Oct 19 '17 00:10 viewDidAppear

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #84   +/-   ##
=======================================
  Coverage   80.28%   80.28%           
=======================================
  Files           5        5           
  Lines         208      208           
=======================================
  Hits          167      167           
  Misses         41       41
Impacted Files Coverage Δ
ReSwiftRouter/Routable.swift 0% <ø> (ø) :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 ba52e46...f034537. Read the comment docs.

codecov-io avatar Oct 19 '17 03:10 codecov-io

@hlineholm Since you were working on the protocol last, do you have time to incorporate docstrings like this? E.g. rebase this PR and adjust?

DivineDominion avatar Aug 07 '19 16:08 DivineDominion

Yes @DivineDominion if a get a slot in my calendar I will. Not my highest priority at the moment though.

hlineholm avatar Nov 12 '20 19:11 hlineholm