wwt / SwiftCurrent

A library for managing complex workflows in Swift
https://wwt.github.io/SwiftCurrent/
Apache License 2.0
308 stars 19 forks source link

Suggested changes to DocC #157

Closed Richard-Gist closed 2 years ago

Richard-Gist commented 2 years ago

These are my suggestions to revise the documentation in your PR. As these are fairly extensive I put them in a PR.

Feel free to accept all, pieces, or reject these changes. I did not review or update anything in Section 2 of Core.

IMPORTANT I reverted Morgan's last change as it was causing liblint to fail for me. Feel free to revert my revert if you merge this into your PR.

codecov-commenter commented 2 years ago

Codecov Report

Merging #157 (ac85477) into docc (26caa0d) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             docc     #157   +/-   ##
=======================================
  Coverage   91.27%   91.27%           
=======================================
  Files          94       94           
  Lines        2373     2373           
=======================================
  Hits         2166     2166           
  Misses        207      207           

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 26caa0d...ac85477. Read the comment docs.

Richard-Gist commented 2 years ago

I was able to fix the CocoaPods lib lint by excluding the .docc file. As such, I just committed a revert of my revert.