Skip to content

Commit 9bec94d

Browse files
committed
docs(codex): clarify skip_legacy_codex_prompts suppresses full .codex dir
1 parent d98e275 commit 9bec94d

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

src/specify_cli/__init__.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -963,6 +963,11 @@ def download_and_extract_template(
963963
) -> Path:
964964
"""Download the latest release and extract it to create a new project.
965965
Returns project_path. Uses tracker if provided (with keys: fetch, download, extract, cleanup)
966+
967+
Note:
968+
``skip_legacy_codex_prompts`` suppresses the legacy top-level
969+
``.codex`` directory from older template archives in Codex skills mode.
970+
The name is kept for backward compatibility with existing callers.
966971
"""
967972
current_dir = Path.cwd()
968973

@@ -1031,8 +1036,9 @@ def download_and_extract_template(
10311036
console.print("[cyan]Found nested directory structure[/cyan]")
10321037

10331038
for item in source_dir.iterdir():
1034-
# In Codex skills mode, do not materialize legacy prompt
1035-
# templates under .codex/prompts.
1039+
# In Codex skills mode, do not materialize the legacy
1040+
# top-level .codex directory from older prompt-based
1041+
# template archives.
10361042
if skip_legacy_codex_prompts and ai_assistant == "codex" and item.name == ".codex":
10371043
continue
10381044
dest_path = project_path / item.name
@@ -1086,7 +1092,7 @@ def download_and_extract_template(
10861092
console.print("[cyan]Flattened nested directory structure[/cyan]")
10871093

10881094
# For fresh-directory Codex skills init, suppress legacy
1089-
# prompt-based layout extracted from older archives.
1095+
# top-level .codex layout extracted from older archives.
10901096
if skip_legacy_codex_prompts and ai_assistant == "codex":
10911097
legacy_codex_dir = project_path / ".codex"
10921098
if legacy_codex_dir.is_dir():

0 commit comments

Comments
 (0)