No official documentation is provided for XCTest

Originator:joshavant
Number:rdar://20112861 Date Originated:10-Mar-2015 03:46 PM
Status:Open Resolved:
Product:Documentation Product Version:
Classification:3 - Medium Reproducible:Always
 
Summary:
It appears the only way to understand how the XCTest API works is by reading the headers for individual classes.

This is cumbersome and doesn't lend itself to promoting testing among developers.

Please improve this process?

Steps to Reproduce:
1. Look for XCTest class documentation in iOS documentation docset
2. Look for XCTest class documentation in OS X documentation docset
3. Look for XCTest class documentation in Xcode documentation docset

Expected Results:
Documentation found

Actual Results:
No documentation found

Version:


Notes:


Configuration:
Any configuration, really

Attachments:

Comments

Reply from me (16-Mar-2015 03:39 PM)

I appreciate your detailed response.

Re: 'what you need or want to know beyond what the current documentation provides': While that document does touch on them, it does so in an entirely different format than the rest of the documentation for all the rest of Apple framework APIs. As a developer, this is primarily a workflow concern.

For example, since all of the Apple framework APIs usually come in the standard 'appledoc' web format, and are maintained and distributed in docset files, I rely on a docset viewer - Dash, in this example - while I'm developing to view the documentation for the Apple classes I use.

Since the XCTest APIs are not maintained and distributed in this format, it breaks this workflow, and I need to make a special trip to this article for documentation + usage questions (or I have to read the class headers).

As well, that documentation is in article format, not the standard 'appledoc' format.

All of these factors come together to create a fairly inefficient process to understand + work with the XCTest framework.

Having these available would support existing and well-established development workflows, which would help to promote testing among developers, too!

By joshavant at March 16, 2015, 10:40 p.m. (reply...)

Reply from Apple Developer Relations (16-Mar-2015 09:21 AM)

The guide to using XCTest (how it works and how to use it) is provided in “Testing with Xcode.” The commonly used parts of the XCTest APIs are shown in the “Writing Test Classes and Methods” chapter as part of the example source and/or in the listing of XCTest assertions.

That said, I do agree that an XCTest.framework API reference would be a good thing. For further development of both “Testing with Xcode” and an XCTest API reference, it would be useful to know what you need or want to know beyond what the current documentation provides.

Please provide your response or results by updating your bug report.

Please compress any bundled files (e.g. nested folders) prior to uploading.

By joshavant at March 16, 2015, 10:40 p.m. (reply...)

Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!