Skip to content

Commit e242483

Browse files
Add comment explaining why private functions without docstrings are omitted
Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
1 parent 6af4729 commit e242483

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

hooks/export-functions.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ def main() -> int:
7474
if first_line is not None:
7575
bullets.append(f"- `{func_name}()` (`{module}`) — {first_line}")
7676
elif not func_name.startswith("_"):
77+
# Only track missing docstrings for public functions; private
78+
# functions without a docstring are silently omitted from output.
7779
missing.append((py_file, func_name))
7880

7981
content = os.linesep.join(bullets) + os.linesep

0 commit comments

Comments
 (0)