updates docstring for clarity

Sage-Bionetworks · Jan 28, 2025 · ab260af · ab260af
1 parent 82c4196
commit ab260af
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/synapseclient/models/agent.py b/synapseclient/models/agent.py
@@ -630,7 +630,8 @@ async def main():
         method_to_trace_name=lambda self, **kwargs: f"Get_Agent: {self.registration_id}"
     )
     async def get_async(self, *, synapse_client: Optional[Synapse] = None) -> "Agent":
-        """Gets an existing agent.
+        """Gets an existing custom agent. There is no need to use this method
+        if you are trying to use the baseline agent.
 
         Arguments:
             synapse_client: If not passed in and caching was not disabled by