swiftlang/swift

[SR-3752] Remove redundant word "Index" from Collection properties/typealiases

Open

#46,337 opened on Jan 26, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (69,989 stars) (10,719 forks)batch import
affects ABIgood first issueimprovementstandard libraryswift evolution proposal needed

Description
Previous ID SR-3752
Radar rdar://problem/29976316
Original Reporter @airspeedswift
Type Improvement
Votes 0
Component/s Standard Library
Labels Improvement, AffectsABI, StarterProposal
Assignee None
Priority Medium

md5: 0c809e36d2916cefa628bdb99c61a0e8

Issue Description:

The two properties "startIndex" and "endIndex", and the typealias IndexDistance should have the word "Index" removed, in order to reduce clutter. The meaning is clear without it.

For source compatibility reasons, deprecated computed properties or a typealias should be provided.

Contributor guide

Tech stack
swift
Domain
developer experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift programming languageDeprecation attribute usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the definitions of `startIndex`, `endIndex`, and `IndexDistance` in the Swift standard library source code (likely in `stdlib/public/core/Collection.swift` or similar). Add deprecated computed properties `start` and `end` for `startIndex` and `endIndex`, and a deprecated typealias `Distance` for `IndexDistance`. Ensure the deprecation warning message guides users to the new names. Test that existing code using the old names compiles with deprecation warnings. Refer to similar past deprecations in the Swift project for patterns.