Skip to content

Commit

Permalink
docs: add docstrings to NonPolynomialReason enum variants
Browse files Browse the repository at this point in the history
  • Loading branch information
AayushSabharwal committed Nov 30, 2024
1 parent e7f4246 commit 14bd0b3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/systems/nonlinear/homotopy_continuation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,21 @@ end
Possible reasons why a term is not polynomial
"""
EnumX.@enumx NonPolynomialReason begin
"""
Exponent of an expression involving unknowns is not an integer.
"""
NonIntegerExponent
"""
Exponent is an expression containing unknowns.
"""
ExponentContainsUnknowns
"""
The base of an exponent is not a polynomial in the unknowns.
"""
BaseNotPolynomial
"""
An expression involves a non-polynomial operation involving unknowns.
"""
UnrecognizedOperation
end

Expand Down

0 comments on commit 14bd0b3

Please sign in to comment.