Skip to content

fix overlong inline literal by adding space, remove triple backtick, replace hyphens with en-dashes#622

Merged
tobixen merged 8 commits intopython-caldav:masterfrom
joshinils:patch-1
Feb 8, 2026
Merged

fix overlong inline literal by adding space, remove triple backtick, replace hyphens with en-dashes#622
tobixen merged 8 commits intopython-caldav:masterfrom
joshinils:patch-1

Conversation

@joshinils
Copy link
Contributor

@joshinils joshinils commented Feb 8, 2026

If an inline literal like "``foo``" is too long to fit on screen, and it doesn't contain spaces, it won't include line-breaks, and for example on mobile this will extend past the right edge of the screen, allowing horizontal scrolling which is not wanted on mobile.

Hence adding more spaces allows for more chances to break the literal, decreasing the chance this happens.

If an inline literal like "``foo``" is too long to fit on screen, and it doesn't contain spaces, it won't include line-breaks, and for example on mobile this will extend past the right edge of the screen, allowing horizontal scrolling which is not wanted on mobile.

Hence adding more spaces allows for more chances to break the literal, decreasing the chance this happens.
Copilot AI review requested due to automatic review settings February 8, 2026 08:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves Sphinx/reStructuredText tutorial readability by ensuring inline literals don’t cause horizontal overflow (especially on mobile) and by using correct inline-literal markup.

Changes:

  • Replaced Markdown-style triple backticks with reST inline literals (double backticks) for an inline method call.
  • Added a missing space after a comma in an inline get_davclient(...) example to improve wrapping opportunities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

joshinils and others added 3 commits February 8, 2026 09:13
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@joshinils joshinils changed the title fix overlong inline literal by adding space, remove triple backtick fix overlong inline literal by adding space, remove triple backtick, replace hyphens with em-dashes Feb 8, 2026
@joshinils joshinils requested a review from Copilot February 8, 2026 08:50
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 7 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@joshinils joshinils changed the title fix overlong inline literal by adding space, remove triple backtick, replace hyphens with em-dashes fix overlong inline literal by adding space, remove triple backtick, replace hyphens with en-dashes Feb 8, 2026
joshinils and others added 2 commits February 8, 2026 10:04
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@tobixen
Copy link
Member

tobixen commented Feb 8, 2026

I hope to get time to look into this a bit later today. Pull requests improving the quality of the documentation is in general mostly welcome, but I'll be AFK over the next few hours :-)

Co-authored-by: joshinils <34302971+joshinils@users.noreply.github.com>
@tobixen tobixen merged commit 32620d6 into python-caldav:master Feb 8, 2026
8 checks passed
@tobixen
Copy link
Member

tobixen commented Feb 8, 2026

Oh. I'm sorry to say that the tutorial you were editing was already an old version of it. The newest version is on the v3.0-dev branch. I will try to resolve the conflicts there, but it may seem like all the stuff you were fixing was already fixed or removed in the v3.0-dev branch.

@joshinils joshinils deleted the patch-1 branch February 10, 2026 11:53
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.

2 participants