Skip to content

Commit 0414fe6

Browse files
committed
docs: capitalize Prompt and Agent in doc strings
1 parent d30cc33 commit 0414fe6

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

src/humanloop/client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -391,18 +391,18 @@ def pull(self,
391391
environment: str | None = None,
392392
path: str | None = None
393393
) -> List[str]:
394-
"""Pull prompt and agent files from Humanloop to local filesystem.
394+
"""Pull Prompt and Agent files from Humanloop to local filesystem.
395395
396396
This method will:
397-
1. Fetch prompt and agent files from your Humanloop workspace
397+
1. Fetch Prompt and Agent files from your Humanloop workspace
398398
2. Save them to the local filesystem using the client's files_directory (set during initialization)
399399
3. Maintain the same directory structure as in Humanloop
400400
4. Add appropriate file extensions (.prompt or .agent)
401401
402402
The path parameter can be used in two ways:
403403
- If it points to a specific file (e.g. "path/to/file.prompt" or "path/to/file.agent"), only that file will be pulled
404-
- If it points to a directory (e.g. "path/to/directory"), all prompt and agent files in that directory will be pulled
405-
- If no path is provided, all prompt and agent files will be pulled
404+
- If it points to a directory (e.g. "path/to/directory"), all Prompt and Agent files in that directory will be pulled
405+
- If no path is provided, all Prompt and Agent files will be pulled
406406
407407
The operation will overwrite existing files with the latest version from Humanloop
408408
but will not delete local files that don't exist in the remote workspace.
@@ -422,7 +422,7 @@ def pull(self,
422422
423423
:param environment: The environment to pull the files from.
424424
:param path: Optional path to either a specific file (e.g. "path/to/file.prompt") or a directory (e.g. "path/to/directory").
425-
If not provided, all prompt and agent files will be pulled.
425+
If not provided, all Prompt and Agent files will be pulled.
426426
:return: List of successfully processed file paths.
427427
"""
428428
return self._sync_client.pull(

src/humanloop/sync/sync_client.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def _get_file_content_impl(self, path: str, file_type: FileType) -> str:
6262
6363
Args:
6464
path: The normalized path to the file (without extension)
65-
file_type: The type of file (prompt or agent)
65+
file_type: The type of file (Prompt or Agent)
6666
6767
Returns:
6868
The file content
@@ -95,7 +95,7 @@ def get_file_content(self, path: str, file_type: FileType) -> str:
9595
9696
Args:
9797
path: The normalized path to the file (without extension)
98-
file_type: The type of file (prompt or agent)
98+
file_type: The type of file (Prompt or Agent)
9999
100100
Returns:
101101
The file content
@@ -154,8 +154,8 @@ def _save_serialized_file(self, serialized_content: str, file_path: str, file_ty
154154
155155
Args:
156156
serialized_content: The content to save
157-
file_path: The path where to save the file
158-
file_type: The type of file (prompt or agent)
157+
file_path: The path to save the file to
158+
file_type: The type of file (Prompt or Agent)
159159
160160
Raises:
161161
Exception: If there is an error saving the file
@@ -207,7 +207,7 @@ def _pull_directory(self,
207207
directory: str | None = None,
208208
environment: str | None = None,
209209
) -> List[str]:
210-
"""Sync prompt and agent files from Humanloop to local filesystem.
210+
"""Sync Prompt and Agent files from Humanloop to local filesystem.
211211
212212
If `path` is provided, only the files under that path will be pulled.
213213
If `environment` is provided, the files will be pulled from that environment.
@@ -241,7 +241,7 @@ def _pull_directory(self,
241241

242242
# Process each file
243243
for file in response.records:
244-
# Skip if not a prompt or agent
244+
# Skip if not a Prompt or Agent
245245
if file.type not in ["prompt", "agent"]:
246246
logger.warning(f"Skipping unsupported file type: {file.type}")
247247
continue

0 commit comments

Comments
 (0)