Switch README extraction to use output directory path names#401
Merged
rosafilgueira merged 8 commits intoSoftwareUnderstanding:devfrom Jan 17, 2023
Merged
Conversation
…ng/dev Merge pull request SoftwareUnderstanding#397 from SoftwareUnderstanding/main
…ng/dev contribution guidelines
…ng/dev version increase for pypi
Collaborator
|
Thanks, looks good on my end (except for that |
Contributor
Author
Thanks for spotting! I've removed those in 6167769. |
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
3 participants
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.
Currently the README extraction feature uses the path of README files in the input directory as keys in the generated JSON. This is inconsistent with the rest of the JSON, as directory paths are given relative to the output directory.
This pull request changes the paths of extracted README files to use the output directory path and ammends relevant unit test.
Example
Consider a repository with a README.md file at the root. Previously, calling
inspect4py -i ../repo -o out -rmwould extract the README with the path../repo/README.mdin the JSON. This fix corrects the output toout/repo/README.md.