Document the use cases for verbatim and why it cannot be used in inline assembly
- Dominant language
- C++
- Stars
- 25.7k
- Forks
- 6.2k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 21
Description
## Page
https://docs.soliditylang.org/en/v0.8.25/yul.html#verbatim
## Problem
The current documentation does not say much about the potential use cases for `verbatim`. My understanding is that this syntax was added in order for Optimism to avoid having to maintain a fork of solc. This seems like a problem that many rollups/ L2s will encounter, and so I think it should be more explicitly documented.
Furthermore, it would be helpful to add a note about why this syntax is unavailable in inline assembly, and why it will remain so in the near future.
## More Context
I've asked some questions about `verbatim` in the Matrix server, which have been answered by @cameel. His answers would be a good starting point for an updated documentation:
## Related
https://github.com/ethereum/solidity/issues/12067
Contributor guide
Research direction
Start with the Yul documentation's verbatim section at the linked page, then review the related issue and the Matrix answers referenced in the report. Document the potential use cases for verbatim and explain why it is unavailable in inline assembly and why that limitation is expected to remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- solidity
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100