[SR-6360] Catch the reasonable mistake 'UnsafeRawMutableBufferPointer'

[belkadan]

Previous ID	SR-6360
Radar	None
Original Reporter	@belkadan
Type	Improvement
Status	In Progress
Resolution

Additional Detail from JIRA

Votes	0
Component/s	Standard Library
Labels	Improvement, StarterBug
Assignee	None
Priority	Medium

md5: 3a178be12fd6e25113883737a47f684b

Issue Description:

I had to write something today using UnsafeMutableRawBufferPointer and accidentally wrote UnsafeRawMutableBufferPointer (switching the "Raw" and the "Mutable"). The current order makes sense because (Unsafe)MutableRawBufferPointer is more similar to (Unsafe)RawBufferPointer than it is to (Unsafe)MutableBufferPointer, but you have to stop and think about that to be sure. We could make things easier on people by adding an unavailable typealias with a renamed field.

@available(*, unavailable, renamed: "UnsafeMutableRawBufferPointer")
typealias UnsafeRawMutableBufferPointer = UnsafeMutableRawBufferPointer

[belkadan]

Starter bug instructions: put a test in test/stdlib/UnsafePointerDiagnostics.swift.

[belkadan]

Resetting assignee on all Starter Bugs not touched since 2018.

[glessard]

Jordan's suggestion is interesting, but we couldn't possibly do this for every symbol where a common typo can occur. There could perhaps be a pass to try and find a suggestion after compilation fails due to an unknown symbol.

[devKobe24]

Should I stop the ongoing work related to this project then?

cc: @glessard