From 9c97d4a37d2fb6a6f58d272b388ad5773d80d448 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?=
 <16805946+edgarrmondragon@users.noreply.github.com>
Date: Fri, 19 Jul 2024 18:45:06 -0600
Subject: [PATCH] docs: Document that `get_starting_timestamp` requires setting
 a non-null replication_key (#2557)

* docs: Document that `get_starting_timestamp` requires setting a non-null replication_key

* Use `note` admonition

* Reference as attribute
---
 singer_sdk/streams/core.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/singer_sdk/streams/core.py b/singer_sdk/streams/core.py
index c588a9729..ed9052ae0 100644
--- a/singer_sdk/streams/core.py
+++ b/singer_sdk/streams/core.py
@@ -249,6 +249,11 @@ def get_starting_replication_key_value(
 
         Returns:
             Starting replication value.
+
+        .. note::
+
+           This method requires :attr:`~singer_sdk.Stream.replication_key` to be set
+           to a non-null value, indicating the stream should be synced incrementally.
         """
         state = self.get_context_state(context)
 
@@ -280,6 +285,11 @@ def get_starting_timestamp(
 
         Raises:
             ValueError: If the replication value is not a valid timestamp.
+
+        .. note::
+
+           This method requires :attr:`~singer_sdk.Stream.replication_key` to be set
+           to a non-null value, indicating the stream should be synced incrementally.
         """
         value = self.get_starting_replication_key_value(context)