Skip to content

docs: fix terminal title config description#15215

Merged
Carreau merged 1 commit into
ipython:mainfrom
zhouzhou626:docs/fix-term-title-format-description-15177
May 21, 2026
Merged

docs: fix terminal title config description#15215
Carreau merged 1 commit into
ipython:mainfrom
zhouzhou626:docs/fix-term-title-format-description-15177

Conversation

@zhouzhou626
Copy link
Copy Markdown
Contributor

Summary

  • Updates the TerminalInteractiveShell.term_title_format help text so the generated configuration docs keep the description, trait type, and default value in the correct places.
  • Avoids the colon that caused the {cwd} substitution text to be parsed as a field in the rendered docs.

Closes #15177.

Tests

  • git diff --check
  • python docs/autogen_config.py and checked the generated terminal.rst entry
  • Checked the generated HTML snippet for TerminalInteractiveShell.term_title_format
  • python -m pytest tests/test_interactiveshell.py tests/test_application.py

@Carreau Carreau merged commit 45715c5 into ipython:main May 21, 2026
22 checks passed
@Carreau Carreau added this to the 9.14 milestone May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: term_title_format description is malformed

2 participants