The `!` suffix
Open
Nobody has claimed this yet.
P-low
refactoring
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Andrew Kent pointed out we were using the ! for both macros and functions that may panic at runtime.
We decided to use it only for functions that panic, and have started making the changes, but we still have to-do items.
- The string interpolation notations are still using
!. - Some functions that may panic at runtime still don't have
!. - Add
a[i]!notation for array access that may panic at runtime
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing string interpolation notations and the functions that can panic at runtime, then compare their current use of ! with the issue's rule. Done means interpolation no longer uses ! as a macro marker, all relevant panicking functions use it, and array access supports a[i]!.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100