wording clarifications #20
Conversation
README.md
Outdated
| #### 3. Events | ||
|
|
||
| ##### A. Events names should be past tense. | ||
| #### 3. Events names should be past tense. |
There was a problem hiding this comment.
I think we were getting to have too many levels which made it hard to follow
There was a problem hiding this comment.
we could also instead link some sections out to different READMEs as an alternative
There was a problem hiding this comment.
imo grouping is helpful and separate readmes would require more work, but we have talked about making a doc site. Agree we are pushing a single thing to the limit
There was a problem hiding this comment.
hmm I guess it's a bit confusing that some are grouped and some aren't. Should we group all then?
| or | ||
| If a function should never be called from another contract, it should be marked private and its name should have a leading underscore. | ||
|
|
||
| #### Justification |
There was a problem hiding this comment.
We don't have Justification elsewhere where we explain reasoning, so I am hesitant to mix up the format. (I used to have something like this but removed for consistency)
There was a problem hiding this comment.
I think exceptions should require justification. This is the only exception we've listed so I would expect future ones to have justification as well, but might not be present right now
README.md
Outdated
|
|
||
| ```solidity | ||
| using Library for bytes | ||
| bytes._function() | ||
| ``` | ||
|
|
||
| Note, we cannot remedy this by insisting on the use public functions. Whether a library functions are internal or external has important implications. From the [Solidity documentation](https://docs.soliditylang.org/en/latest/contracts.html#libraries) | ||
| We could remedy this by insisting on the use public functions. However, developers may prefer internal functions because they are more gas efficient to call, due to how libraries are compiled in Solidity: |
There was a problem hiding this comment.
imo is confusing to say "we could" remedy. Maybe like "We should not remedy this by ..."
anikaraghu
force-pushed
the
anika/edits
branch
2 times, most recently
from
957bcb9 to
f77a08b
Compare
|
Review Error for xenoliss @ 2024-05-08 12:03:46 UTC |
anikaraghu
force-pushed
the
anika/edits
branch
3 times, most recently
from
ec2ed93 to
0b8a579
Compare
Mostly nits I noticed while reading through that can help make it easier to read