Permalink
Browse files

Clarified header documentation for RKRequest's cancel method.

  • Loading branch information...
1 parent fc5f2b3 commit 20fb9043b34120f2c80ae2102f19058edd571636 @grgcombs grgcombs committed Sep 13, 2011
Showing with 6 additions and 3 deletions.
  1. +6 −3 Code/Network/RKRequest.h
View
@@ -285,9 +285,12 @@ typedef enum RKRequestBackgroundPolicy {
/**
* Cancels the underlying URL connection.
- * This will send the requestDidCancel: delegate method
- * if your delegate responds to it. It then nils out the delegate
- * to ensure no more messages are sent to it.
+ * This will call the requestDidCancel: delegate method
+ * if your delegate responds to it. This does not subsequently
+ * set the the request's delegate to nil. However, it's good
+ * practice to cancel the RKRequest and immediately set the
+ * delegate property to nil within the delegate's dealloc method.
+ * @see NSURLConnection:cancel
*/
- (void)cancel;

0 comments on commit 20fb904

Please sign in to comment.