lionheart / openradar-mirror

A mirror of radars pulled from http://openradar.me/.
246 stars 17 forks source link

32923415: List-style API diff document should be released with iOS announcement #17707

Open openradar-mirror opened 7 years ago

openradar-mirror commented 7 years ago

Description

Summary: Immediately after today's WWDC keynote where iOS 11 was announced, a new set of documentation and information was released to developers about iOS 11.

Included in this set of documentation is information about API changes - i.e. modified, added, and deprecated APIs - which, currently, can only be viewed through the Apple Developer Documentation viewer, located here: https://developer.apple.com/documentation?changes=latest_minor

Unfortunately, this viewer is a poor tool for broadly analyzing the large number of API changes that come with a major new release of the OS. Most importantly, the viewer requires users to drill down through the class hierarchy to discover changes. This is cumbersome and slow.

In the past, a 'list-style' API diff document was published. This is an example of this: https://developer.apple.com/library/content/releasenotes/General/iOS10APIDiffs/

This list-style format is a far better format for quickly identifying API changes. All changes are summarised on a single page, without requiring the user to manually drill down through a class hierarchy and separate differences from unchanged APIs.

It is requested that this style of documentation is added to the standard set of documentation released at announcement-time.

Steps to Reproduce: Assess API diffs using https://developer.apple.com/documentation?changes=latest_minor

Expected Results: An easy, convenient way to assess all API changes

Actual Results: A hard, cumbersome way to assess all API changes

Version: iOS 11

Notes:

- Product Version: iOS 11 Created: 2017-06-22T14:16:34.095350 Originated: 22-Juni-2017 04:16 PM Open Radar Link: http://www.openradar.me/32923415

openradar-mirror commented 7 years ago

Modified: 2017-06-28T15:04:49.266170