Skip to content

QL language specification: bring library path documentation up to date#3476

Merged
hmakholm merged 5 commits intogithub:masterfrom
hmakholm:pr/module-res-update
Jun 5, 2020
Merged

QL language specification: bring library path documentation up to date#3476
hmakholm merged 5 commits intogithub:masterfrom
hmakholm:pr/module-res-update

Conversation

@hmakholm
Copy link
Copy Markdown
Contributor

This part of the documentation was out of date by not mentioning QL packs, or identifying query directories by qlpack.yml files.

I think it was also incorrect when it implied that an import statement in a library will be resolved against a query directory found releative to the .qll rather than the query directory of the original .ql file. (At least I can't find any code that would implement that behavior).

Closes: https://github.com/github/semmle-docs/issues/91

Review: @alexet for technical accuracy, @shati-patel for wording and organization.

@hmakholm hmakholm requested a review from alexet May 14, 2020 14:49
@hmakholm
Copy link
Copy Markdown
Contributor Author

Perhaps it would be better to put the new section a level higher, between "Architecture" and "Name Resolution"?

@shati-patel
Copy link
Copy Markdown
Contributor

Perhaps it would be better to put the new section a level higher, between "Architecture" and "Name Resolution"?

Thanks so much for this PR @hmakholm! I will review the text changes shortly.
I think you're right, it would be best to move the new section under "Architecture" (perhaps as a subheading?) since that's where the library path is first mentioned.

@hmakholm
Copy link
Copy Markdown
Contributor Author

OK, I've force-pushed an amended commit that moves the new section.

Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for writing this @hmakholm! I've made some minor suggestions for clarity/consistency.

Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Comment thread docs/language/ql-handbook/language.rst Outdated
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
shati-patel
shati-patel previously approved these changes May 15, 2020
Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good from my point of view! Over to @alexet for any technical comments.

Comment thread docs/language/ql-handbook/language.rst Outdated
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
@shati-patel shati-patel changed the title QL handbook: bring library path documentation up to date QL language specification: bring library path documentation up to date May 19, 2020
Copy link
Copy Markdown
Contributor

@alexet alexet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a

Comment thread docs/language/ql-handbook/language.rst Outdated
Put 'the query directory of the current file` back in the description.
alexet
alexet previously approved these changes Jun 5, 2020
@alexet
Copy link
Copy Markdown
Contributor

alexet commented Jun 5, 2020

@shati-patel It now looks good to me from a technical point of view. Do you want have a another look from a wording point of view for the changes?

Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alexet and @hmakholm! I've corrected a small typo, but this looks good to go otherwise 🎉

Comment thread docs/language/ql-handbook/language.rst Outdated
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
@hmakholm hmakholm dismissed stale reviews from alexet via c2c70d7 June 5, 2020 16:01
@hmakholm
Copy link
Copy Markdown
Contributor Author

hmakholm commented Jun 5, 2020

Thanks @shati-patel. Unfortunately fixing the typo cancelled the existing approvals so I'll need a new one :-)

Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@hmakholm hmakholm merged commit d2d235d into github:master Jun 5, 2020
@hmakholm hmakholm deleted the pr/module-res-update branch June 5, 2020 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants