Skip to content

Commit 81e1ac1

Browse files
committed
Improve comments
1 parent 4fc4453 commit 81e1ac1

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

scripts/generate-pixi-toml.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,15 @@ def comment_out_environments_that_wont_solve(
253253
# Create a new table to rebuild with the desired order
254254
new_environments_table = tomlkit.table()
255255

256-
COMMENT_TEXT = "Disable non-default environments pending <https://github.com/prefix-dev/pixi/issues/2725>"
256+
COMMENT_TEXT_1 = (
257+
"Disable non-default environments pending "
258+
"<https://github.com/prefix-dev/pixi/issues/2725>"
259+
)
260+
COMMENT_TEXT_2 = (
261+
"If you want to re-enable some of these, it's recommended to "
262+
"remove the solve-group key."
263+
)
264+
257265
# Process each key-value pair in the original table
258266
for key, value in environments_item.items():
259267
if key == "default":
@@ -262,7 +270,8 @@ def comment_out_environments_that_wont_solve(
262270

263271
# Add explanatory comment at the beginning
264272
new_environments_table.append(None, tomlkit.nl())
265-
new_environments_table.append(None, tomlkit.comment(COMMENT_TEXT))
273+
new_environments_table.append(None, tomlkit.comment(COMMENT_TEXT_1))
274+
new_environments_table.append(None, tomlkit.comment(COMMENT_TEXT_2))
266275
else:
267276
# Convert other environments to comments
268277
comment_text = f"{key} = {value.as_string()}"

0 commit comments

Comments
 (0)