style: use plain comments for in-body implementation notes - #45
Open
mfw78 wants to merge 1 commit into
Open
Conversation
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 04:01
ea5d427 to
d822b7d
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 04:01
f23ee93 to
bdd0dc7
Compare
mfw78
marked this pull request as ready for review
July 30, 2026 06:52
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 06:59
bdd0dc7 to
3b1a01a
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 06:59
d822b7d to
1befa00
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
2 times, most recently
from
July 30, 2026 07:07
6979147 to
81fd938
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 07:07
1043cdd to
0104481
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 07:09
81fd938 to
f1e3591
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 07:14
83539c7 to
9c72493
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 07:14
f1e3591 to
968943e
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 07:18
9c72493 to
99bfe4a
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
2 times, most recently
from
July 30, 2026 07:22
1ef8c09 to
209a7fa
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
2 times, most recently
from
July 30, 2026 07:26
2c7570f to
47bf1e7
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 07:26
209a7fa to
34abd08
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 07:33
47bf1e7 to
a1f8a8a
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 07:33
34abd08 to
7bdae74
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 08:23
a1f8a8a to
e343718
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 08:23
7bdae74 to
b569442
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 08:42
e343718 to
7a5a798
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
2 times, most recently
from
July 30, 2026 09:51
7229256 to
fe5f94f
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 09:51
7a5a798 to
a060d1c
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 09:54
fe5f94f to
8182be8
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 09:54
a060d1c to
09f41a3
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 10:24
8182be8 to
fe2cdf4
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 10:40
4ea86b7 to
7a4d81a
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 10:40
fe2cdf4 to
34795a3
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 13:55
9f41967 to
f13c656
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 13:55
47f2219 to
7a7e6cf
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 14:25
f13c656 to
deee630
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 14:25
7a7e6cf to
2034f3a
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 23:43
deee630 to
84cb438
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 30, 2026 23:43
2034f3a to
72fdc2b
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 30, 2026 23:51
84cb438 to
933737d
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
3 times, most recently
from
July 31, 2026 00:12
49bcb00 to
c312d8d
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 00:12
140abeb to
49c05c3
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 00:14
c312d8d to
de716d6
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
2 times, most recently
from
July 31, 2026 04:00
a2b4d6d to
3e2f141
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 04:00
de716d6 to
0267b62
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 05:26
3e2f141 to
58308d7
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
2 times, most recently
from
July 31, 2026 06:10
001c0a5 to
469fe25
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 06:10
58308d7 to
18e270e
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 06:14
469fe25 to
f7b6d6e
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 06:29
3f530a5 to
1a881b4
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 06:29
f7b6d6e to
129e08d
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 06:31
1a881b4 to
fb563a6
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 06:31
129e08d to
1580f39
Compare
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 06:42
fb563a6 to
3b1cd6a
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 06:42
1580f39 to
cbad447
Compare
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
solc only recognises NatSpec on declarations, so a `@dev` tag inside a function body is inert: it documents nothing and no tooling reads it. Demote those to ordinary `//` and `/* */` comments and drop the tag, so that a doc comment in the tree always means NatSpec. This is the companion to the NatSpec standardisation earlier in the stack, which deliberately left in-body comments alone. It is separable from the rest of the train and can be dropped without affecting anything below it.
mfw78
force-pushed
the
docs/monitoring-service-deployments
branch
from
July 31, 2026 06:54
3b1cd6a to
5ce21b9
Compare
mfw78
force-pushed
the
style/in-body-comments
branch
from
July 31, 2026 06:54
cbad447 to
29caf59
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
solc only recognises NatSpec on declarations, so a
@devtag inside a function body is inert: it documents nothing and no tooling reads it. This demotes the 25 remaining cases to ordinary comments and drops the tag, so that a doc comment in the tree always means NatSpec.///* */block rather than a/** */doc blockThis is the companion to #42, which deliberately left in-body comments alone: expanding a one-line note inside a function body into a three-line doc block would have made the code harder to read, not easier.
This PR is separable. It sits at the tip and nothing below it depends on it, so it can be closed without affecting the rest of the train if you would rather leave in-body comments as they are.
How to test
Green (154 passing). The change touches only comments.
Part of #1.