docs: Improved package.py error message for missing source_paths #88
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
ers81239
changed the title
ers81239
force-pushed
the
improved_error_message
branch
2 times, most recently
from
b67517c to
91cb23d
Compare
ers81239
changed the title
ers81239
force-pushed
the
improved_error_message
branch
from
91cb23d to
b58cfec
Compare
|
Thanks for the addition! |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
Changed the wording and included the failing
source_pathwhen it can't be found. Added explanation to both the error message and the README.md regarding how relative paths are interpreted.Motivation and Context
I spent 30 minutes trying to interpret "source_path must be set" when it was set, but its relativity was wrong.
Breaking Changes
None.
How Has This Been Tested?
Manual testing with valid and invalid paths. This is my first time using the module, so I don't have a complex source_path, so complex source_paths aren't tested.