docs: clarify 'directory structure' wording in package discovery#5229
Open
SAY-5 wants to merge 1 commit into
Open
docs: clarify 'directory structure' wording in package discovery#5229SAY-5 wants to merge 1 commit into
SAY-5 wants to merge 1 commit into
Conversation
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
1 participant
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.
Summary of changes
Adds a parenthetical clarification in
docs/userguide/package_discovery.rstexplaining what "correspond exactly to the directory structure" means before thepackage_direxample, so readers know the phrase refers to the repository layout versus the dotted package hierarchy installed on the end-user's machine. This is the wording the reporter on #4109 specifically asked about, and @abravalheri confirmed on the same issue: "We are looking for volunteers to help update the documentations. Please feel free to open PRs if you feel you can help."Closes #4109
Pull Request Checklist
newsfragments/.(See documentation for details)