docs: Clarify bytes vs string encoding in ABI specification examples #16006
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.
This PR addresses the documentation issue raised in #15303 regarding the confusion between bytes and string encoding in the ABI specification examples.
Changes
bar(bytes3[2])
example to use explicit byte values (hex"616263"
) instead of string literals ("abc"
)bytes
andstring
typessam(bytes,bool,uint[])
example to better reflect raw bytes usageContext
The current documentation may mislead developers by showing string literals where byte values should be used. This change makes the examples more accurate and helps prevent confusion between string and bytes encoding.
Related Issues
Fixes #15303
Additional Notes