Make eutil:getPreference#2 and edition:getPreferencesURI#1 more robust
#428
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
the parameter `$uri` is optional now. If `$uri` is empty or no reference to preferences is found the fallback `$edition:default-prefs-location` will be returned
* improvements to documentation * wrap a try/catch block around the doc-function for more robustness since the doc-function will fail for non-existent URIs * simplify the lookup. There's no need for the fallback to "edirom-prefs.xml" since this is already done by `edition:getPreferencesURI#1`
bwbohl
previously approved these changes
Sep 12, 2024
Co-authored-by: Benjamin W. Bohl <[email protected]>
bwbohl
approved these changes
Sep 12, 2024
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, Context and related Issue
The function
eutil:getPreference#2has an optional parameter$editionbut is callingedition:getPreferencesURI($edition)where the function parameter is not optional but required.So, if
eutil:getPreference#2is called with an empty$editionparameter an error is thrown byedition:getPreferencesURI#1:I separated out the various steps into four commits and added (hopefully) appropriate documentation to the individual commits.
How Has This Been Tested?
Tested locally
Types of changes
Checklist