Improve setting explanation in the guide#2403
Merged
Merged
Conversation
hodgestar
approved these changes
Jun 14, 2024
hodgestar
left a comment
Contributor
There was a problem hiding this comment.
Left some documentation suggestions, but otherwise looks good. Happy for this to be merged once you're happy with it and tests pass.
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.
Description
Completed the guide page of the settings to include missing entries as well as options included in
settings.coreandsettings.compile. AddedCoreOptionsandCompileOptionsto the apidoc and completed the docstrings.I also removed settings that are no longer used anywhere.
Lastly I changed the default for
accept_floatcompile option.Presently, if an args is a float it cannot be updated to a complex:
Creating a new coefficient work would be needed.
This will certainly cause an issue eventually, but updating it to complex automatically would cause some error with brmesolve spectra: (
w > w0) as complex cannot be compared.Without types, string are not any better than functions so removing them altogether is not ideal.
So I changed it to use complex when no comparison are done and float otherwise.
Related issues or PRs
fix #1524