meejah / txtorcon

Twisted-based asynchronous Tor control protocol implementation. Includes unit-tests, examples, state-tracking code and configuration abstraction.
http://fjblvrw2jrxnhtg67qpbzi45r7ofojaoo3orzykesly2j3c2m3htapid.onion/
MIT License
250 stars 72 forks source link

Merge documentation fixes #208

Closed meejah closed 7 years ago

meejah commented 7 years ago

This "mostly" just merges all the documentation and examples upgrades from release-1.x (basically "documentation re-write") but also does a few "documentation-driven programming" fixups to various APIs etc.

coveralls commented 7 years ago

Coverage Status

Coverage decreased (-0.0002%) to 99.885% when pulling 3e7bb4210b380454091874365e868ef228d236a2 on merge-documentation-fixes into 99a75899dacc7a02d7d526226052aab4d961f0fa on master.

codecov-io commented 7 years ago

Codecov Report

Merging #208 into master will increase coverage by -0.01%.

@@            Coverage Diff             @@
##           master     #208      +/-   ##
==========================================
- Coverage   99.88%   99.88%   -0.01%     
==========================================
  Files          19       19              
  Lines        3485     3479       -6     
==========================================
- Hits         3481     3475       -6     
  Misses          4        4
Impacted Files Coverage Δ
txtorcon/web.py 100% <ø> (ø) :white_check_mark:
txtorcon/torcontrolprotocol.py 100% <ø> (ø) :white_check_mark:
txtorcon/circuit.py 100% <100%> (ø) :white_check_mark:
txtorcon/controller.py 100% <100%> (ø) :white_check_mark:

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 99a7589...3e7bb42. Read the comment docs.