Skip to content

Fix docstring formatting/signature bugs; drop broken export - #30

Merged
AronT-TLV merged 1 commit into
mainfrom
docs/docstring-formatting-audit
Aug 13, 2026
Merged

Fix docstring formatting/signature bugs; drop broken export#30
AronT-TLV merged 1 commit into
mainfrom
docs/docstring-formatting-audit

Conversation

@AronT-TLV

Copy link
Copy Markdown
Member

Summary

Phase 7.1 — same docstring formatting audit already done in Linear_Algebra (#20), applied here. Tutorial pages (docs/src/*.md) had no hand-typed duplicate signatures to fix — they already pull docstrings via @autodocs.

  • plot_parabola: docstring claimed p::Polynomial; the real parameter is untyped since the function is called with both a Polynomials.Polynomial and a Symbolics expression.
  • plot_hyperbola: removed a dead orphaned docstring describing a stale, no-longer-existing signature (plot_hyperbola(n::Integer)), removed a stray leftover artifact line, and fixed a formula typo ("+ b" instead of "+ k", inconsistent with the surrounding text and the actual code).
  • triangle_area_perim: a blank line + indented description text was accidentally forming a second indented code block, so the description rendered as monospace code instead of prose.
  • accrued_apr, accrued: dropped the function keyword prefix from docstring signature lines, matching the convention already applied in Linear_Algebra and documented in the documenter-jl-conventions skill.
  • Math_Foundations.jl: removed plot_hyperbola_axes from the export list — no such function exists (only plot_hyperbola_axes_varx/_direct do). Julia tolerates exporting an undefined name at load time, so this was silently broken rather than erroring.

Test plan

  • julia --project=docs docs/make.jl builds cleanly with no errors
  • typos passes on both edited source files
  • Verified in the built HTML that plot_parabola, plot_hyperbola, triangle_area_perim, accrued_apr, accrued all render correctly with matching signatures/prose, and a full-page scan found no mangled identifiers
  • Full test suite passes (Pkg.test()): 75/75

🤖 Generated with Claude Code

Phase 7.1: same docstring audit already done in Linear_Algebra, applied to
Math_Foundations. Tutorial pages (docs/src/*.md) had no hand-typed duplicate
signatures to fix — already pull docstrings via @autodocs.

- plot_parabola: docstring claimed p::Polynomial; the real parameter is
  untyped since the function is called with both a Polynomials.Polynomial
  and a Symbolics expression.
- plot_hyperbola: removed a dead orphaned docstring describing a stale,
  no-longer-existing signature, removed a stray leftover artifact line,
  and fixed a formula typo ("+ b" instead of "+ k", inconsistent with the
  surrounding text and the actual code).
- triangle_area_perim: a blank line + indented description text was
  accidentally forming a second indented code block, so the description
  rendered as monospace code instead of prose.
- accrued_apr, accrued: dropped the 'function' keyword prefix from
  docstring signature lines, matching the convention already applied in
  Linear_Algebra and documented in the documenter-jl-conventions skill.
- Math_Foundations.jl: removed `plot_hyperbola_axes` from the export list
  — no such function exists (only plot_hyperbola_axes_varx/_direct do).
  Julia tolerates exporting an undefined name at load time, so this was
  silently broken rather than erroring.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@AronT-TLV
AronT-TLV merged commit 29309a4 into main Aug 13, 2026
5 checks passed
@AronT-TLV
AronT-TLV deleted the docs/docstring-formatting-audit branch August 13, 2026 19:50
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.

1 participant