-
Notifications
You must be signed in to change notification settings - Fork 110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
usability/documentation improvement: MethodError typehints when picking the wrong master equation function and better see also
sections in the documentation
#386
Comments
Provide an example to supplement this question: When we use the time-dependent Hamiltonian
we need to run the evolution by
|
I would like to work on this as my first issue. From the discussion, I understood that we want to add
But to address the first task, I have a question: is it acceptable to have the message hint (by using
|
Thanks for submitting the pull request, @a-eghrari , it is greatly appreciated! My initial reaction was that we probably want more checks to avoid giving the hint when it is not appropriate. But given that we never enter the method, that might be too cumbersome. Do you have any thoughts on that? |
fixed by #395 |
See https://discourse.julialang.org/t/quantumoptics-jl-time-dependent-hamiltonian-cannot-run/113448
When someone picks
master
instead ofmaster_dynamic
, theMethodError
message is not particularly clear. We can use the error message hint functionality to tell them they should probably usemaster_dynamic
. We should also add references in asee also
section so that people looking into one of the methods can easily see there is a related method.The text was updated successfully, but these errors were encountered: