From 1ff5a8e8e23a34fcf6db59d33370e7136a68d4fa Mon Sep 17 00:00:00 2001 From: Shati Patel Date: Mon, 16 Dec 2019 12:28:39 +0000 Subject: [PATCH] Docs: Update references to QL for Eclipse --- CONTRIBUTING.md | 2 +- docs/language/learn-ql/ql-training.rst | 2 +- docs/language/ql-training/cpp/intro-ql-cpp.rst | 2 +- docs/language/ql-training/template.rst | 6 +++--- docs/ql-style-guide.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e074b1c2079d..3196efdc0591 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ Follow the steps below to help other users understand what your query does, and 2. **Format your code correctly** - All of Semmle's standard queries and libraries are uniformly formatted for clarity and consistency, so we strongly recommend that all contributions follow the same formatting guidelines. If you use QL for Eclipse, you can auto-format your query in the [QL editor](https://help.semmle.com/ql-for-eclipse/Content/WebHelp/ql-editor.html). For more information, see the [CodeQL style guide](https://github.com/Semmle/ql/blob/master/docs/ql-style-guide.md). + All of Semmle's standard queries and libraries are uniformly formatted for clarity and consistency, so we strongly recommend that all contributions follow the same formatting guidelines. If you use CodeQL for VS Code, you can autoformat your query in the [Editor](https://help.semmle.com/codeql/codeql-for-vscode/reference/editor.html#autoformatting). For more information, see the [CodeQL style guide](https://github.com/Semmle/ql/blob/master/docs/ql-style-guide.md). 3. **Make sure your query has the correct metadata** diff --git a/docs/language/learn-ql/ql-training.rst b/docs/language/learn-ql/ql-training.rst index 70aeb21f69ad..fcb14476d883 100644 --- a/docs/language/learn-ql/ql-training.rst +++ b/docs/language/learn-ql/ql-training.rst @@ -25,7 +25,7 @@ When you have selected a presentation, use |arrow-r| and |arrow-l| to navigate b Press **p** to view the additional notes on slides that have an information icon |info| in the top right corner, and press **f** to enter full-screen mode. The presentations contain a number of query examples. -We recommend that you download `QL for Eclipse `__ and import the example database for each presentation so that you can find the bugs mentioned in the slides. +We recommend that you download `CodeQL for Visual Studio Code `__ and add the example database for each presentation so that you can find the bugs mentioned in the slides. .. pull-quote:: diff --git a/docs/language/ql-training/cpp/intro-ql-cpp.rst b/docs/language/ql-training/cpp/intro-ql-cpp.rst index 72fa57308f4c..6beff0b708ed 100644 --- a/docs/language/ql-training/cpp/intro-ql-cpp.rst +++ b/docs/language/ql-training/cpp/intro-ql-cpp.rst @@ -106,7 +106,7 @@ Each query library also implicitly defines a module. .. note:: - Queries are always contained in query files with the file extension ``.ql``. `Quick queries `__, run in `QL for Eclipse `__, are no exception: the quick query window maintains a temporary query file in the background. + Queries are always contained in query files with the file extension ``.ql``. Parts of queries can be lifted into `library files `__ with the extension ``.qll``. Definitions within such libraries can be brought into scope using ``import`` statements, and similarly QLL files can import each other’s definitions using “import” statements. diff --git a/docs/language/ql-training/template.rst b/docs/language/ql-training/template.rst index 21c5abef1449..4a5b9b323411 100644 --- a/docs/language/ql-training/template.rst +++ b/docs/language/ql-training/template.rst @@ -27,7 +27,7 @@ Template slide deck Second subheading -.. Set up slide. Include link to QL4E snapshots required for examples +.. Set up slide. Include link to CodeQL databases required for examples .. rst-class:: setup @@ -36,8 +36,8 @@ Setup For this example you should download: -- `QL for Eclipse `__ -- A snapshot +- `CodeQL for Visual Studio Code `__ +- A CodeQL database .. note:: diff --git a/docs/ql-style-guide.md b/docs/ql-style-guide.md index 9e926c0b07ed..a22085f50b75 100644 --- a/docs/ql-style-guide.md +++ b/docs/ql-style-guide.md @@ -3,7 +3,7 @@ ## Introduction This document describes how to format the code you contribute to this repository. It covers aspects such as layout, white-space, naming, and documentation. Adhering to consistent standards makes code easier to read and maintain. Of course, these are only guidelines, and can be overridden as the need arises on a case-by-case basis. Where existing code deviates from these guidelines, prefer consistency with the surrounding code. -Note, if you use QL for Eclipse, you can auto-format your query in the [QL editor](https://help.semmle.com/ql-for-eclipse/Content/WebHelp/ql-editor.html). +Note, if you use CodeQL for VS Code, you can autoformat your query in the [Editor](https://help.semmle.com/codeql/codeql-for-vscode/reference/editor.html#autoformatting). Words in *italic* are defined in the [Glossary](#glossary).