Fix docstring formatting/signature bugs; drop broken export - #30
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 claimedp::Polynomial; the real parameter is untyped since the function is called with both aPolynomials.Polynomialand 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 thefunctionkeyword prefix from docstring signature lines, matching the convention already applied in Linear_Algebra and documented in thedocumenter-jl-conventionsskill.Math_Foundations.jl: removedplot_hyperbola_axesfrom the export list — no such function exists (onlyplot_hyperbola_axes_varx/_directdo). Julia tolerates exporting an undefined name at load time, so this was silently broken rather than erroring.Test plan
julia --project=docs docs/make.jlbuilds cleanly with no errorstypospasses on both edited source filesplot_parabola,plot_hyperbola,triangle_area_perim,accrued_apr,accruedall render correctly with matching signatures/prose, and a full-page scan found no mangled identifiersPkg.test()): 75/75🤖 Generated with Claude Code