Page MenuHomePhabricator

[chronik-client] Apply standardized-ish commenting
ClosedPublic

Authored by bytesofman on Nov 30 2023, 19:13.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABC5ce732a589b9: [chronik-client] Apply standardized-ish commenting
Summary

Use single line comments // for comments of 1 or 2 lines. Use multi-line commments /* */ for longer comments, not including comments on the first and last line of multi-line block

This is the kind of thing that should be linted but I was not able to find support for this in either eslint or prettier. Because this issue has not come up in any other repo, just patching it here and moving on is best available approach.

Test Plan

Confirm changes are only to comments

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Fabien added inline comments.
modules/chronik-client/src/ChronikClient.ts
10 ↗(On Diff #43335)

I think you're missing the point: previously this was an bad layout for a doxygen comment. So there was documentation but will likely look weird due to the layout. Now you don't have doxygen comment anymore so you cannot generate the doc either. It can be OK for some cases but here you want to document the class.

Fabien requested changes to this revision.Dec 1 2023, 09:18
This revision now requires changes to proceed.Dec 1 2023, 09:18
bytesofman marked an inline comment as done.

Maintain doxygen comments; standardize so that they are either one-liners or include blank top and bottom lines

Fabien added inline comments.
modules/chronik-client/src/ChronikClient.ts
211 ↗(On Diff #43352)

You missed this one

This revision is now accepted and ready to land.Dec 1 2023, 19:32