Project

General

Profile

Actions

Bug #22077

open

Fix rendering of triple-minus-hyphen in PySDK API docs

Added by Brett Smith 3 months ago. Updated 3 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
-
Story points:
-

Description

We wrote our Python documentation style guide with the expectation that the Markdown renderer would convert --- to . And in early versions it did.

After #19929, something changed in our documentation so that this rendering no longer happens consistently. It still happens sometimes, but not all the time. Sometimes it's not even consistent in the same docstring. Compare in this scerenshot: all the arguments use triple-minus-hyphen in the source, and it renders as an em dash for the body argument, but not any others:

Fix this. A fix might need to happen in upstream pdoc or its Markdown rendering library.


Files

clipboard-202409091046-16rdu.png (342 KB) clipboard-202409091046-16rdu.png Brett Smith, 09/09/2024 02:46 PM
Actions #1

Updated by Brett Smith 3 months ago

  • Description updated (diff)
Actions

Also available in: Atom PDF