Improve error messages #177
Merged
Conversation
This file contains 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
Relates to discussion MPh-py#170.
In some of the log and/or error messages in `discovery.py` we referred to Comsol's configuration file of its Java VM (which we parse) as the "Java bridge". This is confusing as the actual (Python-to-)Java bridge is JPype, and we call it that elsewhere in the docs.
The old error message ("Could not locate any Comsol installation.") was
often misunderstood to mean that MPh somehow failed to find any
installed Comsol whatsoever, when in fact it did, but discarded it for
one reason or another.
This usually happens if the folder structure of the Comsol installation
is different from what we expect. Whether it's an old Comsol version or
a new CPU architecture. We don't even want to try and start those
unfamiliar installations.
Relates to issue MPh-py#174.
The old error message ("Only one client can be instantiated at a time.")
was misunderstood to mean that if users hard-deleted the Python client
object (with `del client`), they could hope to work around this
limitation. The documentation already has plenty of information on that,
but the error message is clearer if we once again emphasize that the
limitation applies to the entire Python session.
Relates to discussion MPh-py#173.
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.
Related discussions/issues: #170, #173, #174.