swiftlang/swift

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

Open

#48,910 opened on Nov 10, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Swift (10,719 forks)batch import
good first issueimprovementstandard library

Repository metrics

Stars
 (69,989 stars)
PR merge metrics
 (Avg merge 8d 17h) (510 merged PRs in 30d)

Description
Previous ID SR-6360
Radar None
Original Reporter @belkadan
Type Improvement
Status In Progress
Resolution
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

Contributor guide

Research direction
Understand the naming convention for unsafe pointer types in Swift and locate the file where type aliases are defined. Add an unavailable typealias `UnsafeRawMutableBufferPointer` that renames to `UnsafeMutableRawBufferPointer` with the appropriate availability attribute.
Tech stack
swift
Domain
api
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwiftGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95