QL handbook: Update process for module resolution #3714
Merged
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
|
@hmakholm, this description is deliberately not too detailed, but could you verify it's still correct? |
|
lgtm |
hubwriter
previously approved these changes
Jun 15, 2020
hmakholm
previously approved these changes
Jun 15, 2020
| contain ``<queries language="javascript"/>``.) | ||
| #. If that fails, it looks up ``examples/security/MyLibrary.qll`` relative to the query | ||
| directory, if any. | ||
| The query directory is the first enclosing directory containing a file called ``qlpack.yml``. (Or, in legacy products, a file called ``queries.xml``.) |
There was a problem hiding this comment.
"First" is a bit ambiguous here -- but I'm not sure how to say it better without sounding excessively technical.
| #. If no file is found using the above two checks, it looks up ``examples/security/MyLibrary.qll`` | ||
| relative to each library path entry. The library path depends on the environment where you | ||
| #. If the compiler can't find the library file using the above two checks, it looks up ``examples/security/MyLibrary.qll`` | ||
| relative to each library path entry. The library path depends on the tools you use to |
There was a problem hiding this comment.
Even in an abbreviated description, I think it would be helpful to reveal that this is where the libraryPathDependencies of qlpack.yml comes in. We could still omit the details of how exactly it comes in -- just words that amount to "trouble locating imports? check your libraryPathDependencies".
|
Thanks @hmakholm - good point about the |
hmakholm
reviewed
Jun 15, 2020
Co-authored-by: Henning Makholm <hmakholm@github.com>
hmakholm
approved these changes
Jun 15, 2020
|
Thanks 😄 |
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.
Uses the detailed description from the QL spec (#3476) to update the more lightweight description of module resolution in the QL handbook.