Skip to content

Java: basic version of automodel extraction query docs #14487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 26, 2023

Conversation

kaeluka
Copy link

@kaeluka kaeluka commented Oct 12, 2023

This adds documentation for the Java extraction queries.

Much of this content is writing down "lore" that accumulated over building and maintaining these queries.

I've tried to stick to information that I would find difficult to get across as comments in the ql/qll files.

Dear Reviewer

  • I recommend not reviewing commit-by-commit, the documentation should make sense as a whole.
  • I'm a bit reluctant to make the markdown file too big, because it's difficult to keep them in sync with the implementation: Let me know if there's any content missing 😄
  • I'm trying not to depend on implementation details (that may change) unnecessarily - this would make the documentation prone to going stale quickly. If you spot locations where this obscures the message, please let me know.

@kaeluka kaeluka changed the title Java: basic version of automodel extraction queries Java: basic version of automodel extraction query docs Oct 13, 2023
@kaeluka kaeluka requested a review from tausbn October 24, 2023 11:50
@kaeluka kaeluka marked this pull request as ready for review October 24, 2023 11:54
@kaeluka kaeluka requested a review from a team as a code owner October 24, 2023 11:54
@kaeluka
Copy link
Author

kaeluka commented Oct 24, 2023

@adityasharad: I've promised to ping you once I've written about why there are framework mode candidates that are both sink candidates as well as source candidates. The section called "Parameters as Source Candidates" tries to explain that. 🙂

@aeisenberg: I've also promised to ping you! 👋 👍

No review is required, but always welcome of course :)

@kaeluka kaeluka force-pushed the kaeluka/extraction-query-docs branch from a01c34b to e97456f Compare October 24, 2023 14:31
adityasharad
adityasharad previously approved these changes Oct 24, 2023
Copy link
Collaborator

@adityasharad adityasharad left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Contributor

@aeisenberg aeisenberg left a comment

Choose a reason for hiding this comment

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

Nice. Mostly very minor copy-editing suggestions. My only bigger comment is around including a sentence or two describing what these queries are used for.

@kaeluka
Copy link
Author

kaeluka commented Oct 25, 2023

Thank you for the reviews, @adityasharad and @aeisenberg! I've responded 👌

Copy link
Contributor

@aeisenberg aeisenberg left a comment

Choose a reason for hiding this comment

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

Thank you. Looks good.

@kaeluka kaeluka merged commit 5fe6a5a into main Oct 26, 2023
@kaeluka kaeluka deleted the kaeluka/extraction-query-docs branch October 26, 2023 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants