Skip to content

Fix doctest failure in find_identifiable_functions - #546

Merged
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:fix-docs-build
Aug 26, 2026
Merged

Fix doctest failure in find_identifiable_functions#546
ChrisRackauckas merged 1 commit into
SciML:masterfrom
ChrisRackauckas-Claude:fix-docs-build

Conversation

@ChrisRackauckas-Claude

Copy link
Copy Markdown
Member

Summary

Fixes the failing Documentation workflow (doctest failure in src/identifiable_functions.jl:33-49).

Root cause: two independent issues in the find_identifiable_functions doctest:

  1. The expected output ordered terms as a12 + a01 + a21 / a12*a01, but the currently pinned AbstractAlgebra/Nemo now print multivariate terms in a different (lexicographic-by-name) variable order, producing a01 + a12 + a21 / a01*a12.
  2. The doctest was missing the Logging.disable_logging(Logging.Info) setup that every neighboring doctest in this file's sibling files (util.jl, parametrizations.jl, input_macro.jl) already uses. find_identifiable_functions emits @info progress messages by default, which Documenter's doctest runner captures as part of the evaluated output. Since the # output block never included those log lines, the doctest would fail on this basis alone, independent of the term-ordering issue above.

Fix

  • Updated the expected # output block to match the current term ordering.
  • Added ; setup = :(using Logging; Logging.disable_logging(Logging.Info);) to the ```jldoctest fence, matching the established convention elsewhere in the codebase.

Test plan

  • Ran julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' followed by julia --project=docs docs/make.jl locally against this branch — the full makedocs build (including all doctests) completes successfully with no doctest errors.

Made with Cursor

AbstractAlgebra/Nemo now print multivariate terms in a different
variable order, so the expected doctest output (`a12 + a01 + a21`)
no longer matches the actual output (`a01 + a12 + a21`). Also add
the `Logging.disable_logging(Logging.Info)` doctest setup that every
other doctest in this file's neighbors already uses, since the
`@info` messages emitted by `find_identifiable_functions` were being
captured by Documenter and were never part of the expected `# output`
block, causing the doctest to fail independently of the term
ordering.

Co-authored-by: Cursor <cursoragent@cursor.com>
@ChrisRackauckas
ChrisRackauckas merged commit 51c2ad9 into SciML:master Aug 26, 2026
4 of 6 checks passed
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.

2 participants