Tests: Consistency changes in comments #14606

Change-Id: Iaf02afbcd37631667c6652602496c6f8d4b22a4d

To make functional tests more readable, in-line comments have been slightly reformatted to follow the same standard across all functional test python scripts.

1. Comments should start with '#', followed by a space and the first word capitalized.
2. First letter in a new sentence within a comment should be capitalized.
3. When the word under consideration is a reference to a python object however, the first letter should not be capitalized.

I appreciate the work, but I don't think this will help long term. People will keep writing comments in lower case non-capitalized form or whatever else that violates your proposal, and someone else will have to redo the work again for the new files.

If you want to change the code guidelines to enforce this, that may be one thing, but I don't really know if that's necessary. I'd prefer people write tests, rather than avoid writing them because of a ton of rules on how comments should be formed.

Yes I completely agree with you. I'm not trying to add any new rules to be enforced in the future. I want to change what's already there so that when someone new wants to write tests, if that person cares about how to write comments there is a bigger chance the person will follow the same format.

<!--e57a25ab6845829454e8d69fc972939a-->

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

<!--174a7506f384e20aa4161008e828411d-->

Conflicts

Reviewers, this pull request conflicts with the following ones:

• #14632 (Tests: Fix a comment by fridokus)
• #14494 (Error if # is used in rpcpassword in conf by MeshCollider)
• #14459 (More RPC help description fixes by ch4ot1c)
• #8994 (Testchains: Introduce custom chain whose constructor... by jtimon)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

NACK, even if you add a rule I don't think it's worth the effort enforcing it. So I agree with @kallewoof.