Skip to content

Commit eee6d21

Browse files
committed
docs: add code comments on compatibility
1 parent 6d0a065 commit eee6d21

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

quartodoc/ast.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,12 @@ class represents a section like See Also, etc..
107107

108108
results = []
109109

110+
# griffe < 0.39 w/ numpydoc uses DocstringSectionText for unhandled section
111+
# but later versions always use Admonitions. Note it may still use Text
112+
# for areas of docstrings not associated with particular sections (e.g. freeform
113+
# text betwen a parameters section and the next section).
110114
if isinstance(el, ds.DocstringSectionText):
111-
# griffe < 0.39
115+
# handle griffe < 0.39 case
112116
splits = cls.split_sections(el.value)
113117
for title, body in splits:
114118
sub_cls = cls._registry.get(title.lower(), ds.DocstringSectionText)

0 commit comments

Comments
 (0)