Skip to content

Commit 6c5ec48

Browse files
committed
fix: parameter description list do not render None as default
1 parent 5ed1430 commit 6c5ec48

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

quartodoc/renderers/md_renderer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ def to_definition_list(self):
7777
# in the table display format, not description lists....
7878
# by this stage _required_ is basically a special token to indicate
7979
# a required argument.
80-
if default is not None:
80+
if self.default is not None:
8181
part_default_sep = Span(" = ", Attr(classes=["parameter-default-sep"]))
8282
part_default = Span(default, Attr(classes=["parameter-default"]))
8383
else:

quartodoc/tests/__snapshots__/test_renderers.ambr

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -483,19 +483,19 @@
483483
List
484484
# Parameters {.doc-section .doc-section-parameters}
485485

486-
<code>[**int**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
486+
<code>[**int**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation}</code>
487487

488488
: A description.
489489

490490
# Returns {.doc-section .doc-section-returns}
491491

492-
<code>[]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
492+
<code>[]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation}</code>
493493

494494
: A description.
495495

496496
# Attributes {.doc-section .doc-section-attributes}
497497

498-
<code>[**int**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
498+
<code>[**int**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation}</code>
499499

500500
: A description.
501501
'''
@@ -540,19 +540,19 @@
540540
List
541541
# Parameters {.doc-section .doc-section-parameters}
542542

543-
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
543+
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} []{.parameter-annotation}</code>
544544

545545
: A description.
546546

547547
# Returns {.doc-section .doc-section-returns}
548548

549-
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
549+
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation}</code>
550550

551551
: A description.
552552

553553
# Attributes {.doc-section .doc-section-attributes}
554554

555-
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation} [ = ]{.parameter-default-sep} [None]{.parameter-default}</code>
555+
<code>[**name**]{.parameter-name} [:]{.parameter-annotation-sep} [int]{.parameter-annotation}</code>
556556

557557
: A description.
558558
'''

0 commit comments

Comments
 (0)