fix some style issues with comments
ClosedPublic
Actions

Authored by PiRK on Nov 5 2020, 09:16.

Details

Reviewers

Group Reviewers

Restricted Owners Package	(Owns No Changed Paths)
Restricted Project

Commits

rABC1ade496abd8f: fix some style issues with comments

Summary

D397 added some extra blank lines between comments and the block of code they apply to.

This commit fixes this. A single blank line is used after a comment when it applies to multiple object/classes following it. When the comment describes a single function, it is transformed into a docstring.

I only touched code that already diverged from Core. There are a couple of other comments that could be transformed into docstrings.

Test Plan

arc lint

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Nov 5 2020, 09:16

Owners added a reviewer: Restricted Owners Package.Nov 5 2020, 09:16

Herald added a reviewer: Restricted Project. · View Herald TranscriptNov 5 2020, 09:16

PiRK requested review of this revision.Nov 5 2020, 09:16

remove extra blank line

Harbormaster completed remote builds in B13862: Diff 25444.Nov 5 2020, 09:25

Build Bitcoin ABC Diffs / Diff Testing (build-debug) failed.

Failed tests logs:

====== Bitcoin ABC functional tests: rpc_bind.py ======

------- Stdout: -------
2020-11-05T09:22:02.068000Z TestFramework (INFO): Initializing test directory /work/abc-ci-builds/build-debug/test/tmp/test_runner_₿₵_  _20201105_092200/rpc_bind_607
2020-11-05T09:22:02.069000Z TestFramework (INFO): Check for linux
2020-11-05T09:22:02.091000Z TestFramework (INFO): Check for ipv6
2020-11-05T09:22:02.092000Z TestFramework (INFO): Check for non-loopback interface
2020-11-05T09:22:02.092000Z TestFramework (INFO): Bind test for []
2020-11-05T09:22:02.664000Z TestFramework (INFO): Bind test for []
2020-11-05T09:22:03.175000Z TestFramework (INFO): Bind test for ['[::1]']
2020-11-05T09:22:03.591000Z TestFramework (INFO): Bind test for ['127.0.0.1', '[::1]']
2020-11-05T09:22:04.101000Z TestFramework (INFO): Using interface 172.17.0.2 for testing
2020-11-05T09:22:04.101000Z TestFramework (INFO): Bind test for ['172.17.0.2']
2020-11-05T09:22:04.368000Z TestFramework (ERROR): Unexpected exception caught during testing
Traceback (most recent call last):
  File "/work/test/functional/test_framework/test_framework.py", line 120, in main
    self.run_test()
  File "/work/test/functional/rpc_bind.py", line 135, in run_test
    self._run_nonloopback_tests()
  File "/work/test/functional/rpc_bind.py", line 170, in _run_nonloopback_tests
    [(self.non_loopback_ip, self.defaultport)])
  File "/work/test/functional/rpc_bind.py", line 71, in run_bind_test
    assert_equal(set(get_bind_addrs(pid)), set(expected))
  File "/work/test/functional/test_framework/netutil.py", line 87, in get_bind_addrs
    inodes = get_socket_inodes(pid)
  File "/work/test/functional/test_framework/netutil.py", line 37, in get_socket_inodes
    target = os.readlink(os.path.join(base, item))
FileNotFoundError: [Errno 2] No such file or directory: '/proc/4665/fd/17'
2020-11-05T09:22:04.419000Z TestFramework (INFO): Stopping nodes
2020-11-05T09:22:04.570000Z TestFramework (WARNING): Not cleaning up dir /work/abc-ci-builds/build-debug/test/tmp/test_runner_₿₵_  _20201105_092200/rpc_bind_607
2020-11-05T09:22:04.571000Z TestFramework (ERROR): Test failed. Test logging available at /work/abc-ci-builds/build-debug/test/tmp/test_runner_₿₵_  _20201105_092200/rpc_bind_607/test_framework.log
2020-11-05T09:22:04.571000Z TestFramework (ERROR): Hint: Call /work/test/functional/combine_logs.py '/work/abc-ci-builds/build-debug/test/tmp/test_runner_₿₵_  _20201105_092200/rpc_bind_607' to consolidate all logs

Each failure log is accessible here:
Bitcoin ABC functional tests: rpc_bind.py

Fabien accepted this revision.Nov 5 2020, 09:27

This revision is now accepted and ready to land.Nov 5 2020, 09:27

Harbormaster completed remote builds in B13863: Diff 25445.Nov 5 2020, 09:39

Closed by commit rABC1ade496abd8f: fix some style issues with comments (authored by PiRK). · Explain WhyNov 5 2020, 11:03

This revision was automatically updated to reflect the committed changes.

PiRK added a commit: rABC1ade496abd8f: fix some style issues with comments.