Skip to content
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

Add link to language guides for empty query results #866

Merged
merged 3 commits into from
May 18, 2021

Conversation

eysk-io
Copy link
Contributor

@eysk-io eysk-io commented May 17, 2021

Empty table when no query results are returned is replaced by a message with documentation to the CodeQL Language Guides.

Fixes #551.

Please let me know if this warrants a change to the changelogs and if I should cc @github/docs-content-codeql.

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [n/a] @github/docs-content-codeql has been cc'd in all issues for UI or other user-facing changes made by this pull request.

@aeisenberg
Copy link
Contributor

Thanks for the PR!

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.

This is looking good. One more thing that needs to happen before merging. Can you add an entry in the CHANGELOG.md file? Follow the format of previous entries and add text like this:

Display a helpful message and link to documentation when a query produces no results.

It would also be nice to style this better, with bigger text and margins. But that's something to work on later.

Once you get the changelog updated, we can merge this.

@eysk-io eysk-io requested a review from aeisenberg May 17, 2021 23:07
@eysk-io
Copy link
Contributor Author

eysk-io commented May 17, 2021

Thanks! I would love to pick up the backlog that addresses the styling and maybe a dynamic link to the docs depending on the language. Please let me know if it's okay for me to create an issue for this.

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.

Great work!

@aeisenberg
Copy link
Contributor

Thanks! I would love to pick up the backlog that addresses the styling and maybe a dynamic link to the docs depending on the language. Please let me know if it's okay for me to create an issue for this.

That would be great. Please create an issue. First, can you look at styling and then we can think of a better link to include. There might be something more useful than going to the language guide.

@aeisenberg aeisenberg enabled auto-merge (rebase) May 18, 2021 01:54
@aeisenberg aeisenberg merged commit 3abc8df into github:main May 18, 2021
@eysk-io eysk-io deleted the contributing branch May 21, 2021 03:56
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.

Add link to documentation when a query returns no results
2 participants