Add documentation for Block class public methods

[codecov-commenter]

Codecov Report

Merging #415 (12147ab) into development (9e06eff) will decrease coverage by 0.89%. The diff coverage is n/a.

@@               Coverage Diff               @@
##           development     #415      +/-   ##
===============================================
- Coverage        90.51%   89.61%   -0.90%     
===============================================
  Files               24       23       -1     
  Lines             6063     5414     -649     
===============================================
- Hits              5488     4852     -636     
+ Misses             575      562      -13     

Impacted Files	Coverage Δ
pyrtl/core.py	85.64% <ø> (ø)
pyrtl/compilesim.py	91.01% <0.00%> (-0.23%)	:arrow_down:
pyrtl/rtllib/matrix.py

---

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 9e06eff...12147ab. Read the comment docs.

[timsherwood]

Hi strongwar, thanks for the pull request. It looks great (more and better documentation is always appreciated!) but for some reason it is failing the 3.7 check (but not the 2.7 check). @mdko it says "Error: ERROR: pycodestyle: commands failed" and I think you set that part up. I am wondering if you have any thoughts on why this request might be failing in this weird way (or if all of our 2.7 tests are failing right now).

[mdko]

Hi strongwar, thanks for the pull request. It looks great (more and better documentation is always appreciated!) but for some reason it is failing the 3.7 check (but not the 2.7 check). @mdko it says "Error: ERROR: pycodestyle: commands failed" and I think you set that part up. I am wondering if you have any thoughts on why this request might be failing in this weird way (or if all of our 2.7 tests are failing right now).

It looks like there are style issues. If you go to "Checks" > "Build 3.7" > "Test with Tox" > Expand the "tox: pycodestyle" section, it shows:

pyrtl/core.py:278:1: W293 blank line contains whitespace
pyrtl/core.py:279:60: W2[91](https://github.com/UCSBarchlab/PyRTL/runs/5803277254?check_suite_focus=true#step:5:91) trailing whitespace
pyrtl/core.py:280:1: W2[93](https://github.com/UCSBarchlab/PyRTL/runs/5803277254?check_suite_focus=true#step:5:93) blank line contains whitespace
pyrtl/core.py:288:1: W293 blank line contains whitespace
pyrtl/core.py:289:64: W291 trailing whitespace
pyrtl/core.py:290:1: W293 blank line contains whitespace
pyrtl/core.py:297:1: W293 blank line contains whitespace
pyrtl/core.py:298:60: W291 trailing whitespace
pyrtl/core.py:320:1: W293 blank line contains whitespace
pyrtl/core.py:322:79: W291 trailing whitespace
pyrtl/core.py:385:1: W293 blank line contains whitespace
pyyrtl/core.py:389:1: W293 blank line contains whitespace
pyrtl/core.py:3[94](https://github.com/UCSBarchlab/PyRTL/runs/5803277254?check_suite_focus=true#step:5:94):1: W293 blank line contains whitespace
pyrtl/core.py:3[96](https://github.com/UCSBarchlab/PyRTL/runs/5803277254?check_suite_focus=true#step:5:96):1: W293 blank line contains whitespace
pyrtl/core.py:413:1: W293 blank line contains whitespace
pyrtl/core.py:416:1: W293 blank line contains whitespace
pyrtl/core.py:427:1: W293 blank line contains whitespace
pyrtl/core.py:429:79: W291 trailing whitespace

@strongwar please fix those whitespace issues, and I think we'll be all good to go to pull this in. You should also be able to run tox on your local machine if you don't want to wait for Github signals. Thanks!