doc(storage): warn customers about changes for mocks

coryan · coryan · commit 17e877bf7666 · 2021-07-22T14:07:43.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -67,6 +67,16 @@
 
 [issue-2567]: https://github.com/googleapis/google-cloud-cpp/issues/2567
 
+### Storage:
+
+**BREAKING CHANGES**:
+* The usage of `google::cloud::internal::ObjectReadSource` has changed. If your
+  tests mock how the library uses this class you may need to update your tests.
+  We updated the [mocking examples][storage-mocking-link] to guide you in
+  changing the tests.
+
+[storage-mocking-link]: https://googleapis.dev/cpp/google-cloud-storage/latest/storage-mocking.html
+
 ### Other:
 
 **We have removed the `super/` directory:** `google-cloud-cpp` remains usable in
diff --git a/google/cloud/storage/doc/storage-mocking.dox b/google/cloud/storage/doc/storage-mocking.dox
@@ -7,28 +7,28 @@
 It is possible to mock GCS bucket read and write using gmock framework, this is specially ueeful
 for developer using GCS C++ client library.
 
-### Mocking Successful call of `ReadObject`
+### Mocking Successful call of ReadObject()
 
 Mocking of ReadObject can be achieved by mocking `ObjectReadSource`. The following code snippet
 explains this
 
 @snippet storage_client_mock_samples.cc mock successful readobject
 
-### Mocking Failed call of `ReadObject`
+### Mocking Failed call of ReadObject()
 
 Mocking of ReadObject can be achieved by mocking `ObjectReadSource`. The following code snippet
 explains this
 
 @snippet storage_client_mock_samples.cc mock failed readobject
 
-### Mocking Successful call of `WriteObject`
+### Mocking Successful call of WriteObject()
 
 Mocking of ReadObject can be achieved by mocking `ObjectWriteStreambuf`. The following code snippet
 explains this
 
 @snippet storage_client_mock_samples.cc mock successful writeobject
 
-### Mocking Failed call of `WriteObject`
+### Mocking Failed call of WriteObject()
 
 Mocking of ReadObject can be achieved by mocking `ObjectWriteStreambuf`. The following code snippet
 explains this
