Add note about wordPressComRestApi vs wordPressComRESTAPI

mokagio · mokagio · commit de1c24ce1c78 · 2024-03-22T14:00:13.000+11:00
diff --git a/WordPressKit/ServiceRemoteWordPressComREST.h b/WordPressKit/ServiceRemoteWordPressComREST.h
@@ -24,6 +24,10 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, strong, readonly) WordPressComRestApi *wordPressComRestApi;
 
+/**
+ *  @brief      The interface to the WordPress.com API to use for performing REST requests.
+ *              This is meant to gradually replace `wordPressComRestApi`.
+ */
 @property (nonatomic, strong, readonly) id<WordPressComRESTAPIInterfacing> wordPressComRESTAPI;
 
 /**
