Skip to content

Commit

Permalink
add comment explaining keyword parameter precedence
Browse files Browse the repository at this point in the history
  • Loading branch information
lxvm committed Dec 6, 2023
1 parent 101bf0c commit 8c60d70
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/apps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
# arguments, except that we typically don't want to provide defaults in order to require
# that the user provide the necessary data for the problem

# The precedence of parameters is:
# canonical parameters < parameters passed to integrand constructor < parameters passed to solver
# in particular, canonical parameters are only used to initialize the solver, never to solve
# We are able to provide this precedence of parameters by making all parameters keyword
# arguments. Moreover, positional arguments are reserved for internal use.

# Typically we also want to transform the problem based on the parameters, e.g.
# - precompute some function that only depends on parameters, not variables
# - truncate the limits of frequency integration
Expand Down

0 comments on commit 8c60d70

Please sign in to comment.