Merge pull request #4878 from shati-patel/docs-pullquotes

Docs: Change remaining notes to "pull-quote" directives

Author: shati-patel

docs/codeql/codeql-cli/creating-codeql-query-suites.rst

@@ -16,7 +16,7 @@ mapping with (usually) a single key. The instructions are executed in the order
 they appear in the query suite definition. After all the instructions in the
 suite definition have been executed, the result is a set of selected queries.
 
-.. note::
+.. pull-quote:: Note
 
    Any custom queries that you want to add to a query suite must be in a :doc:`QL
    pack <about-ql-packs>` and contain the correct query metadata. 
@@ -54,7 +54,7 @@ queries using:
 
    - qlpack: <qlpack-name>
 
-.. note::
+.. pull-quote:: Note
 
    When pathnames appear in query suite definitions, they must always
    be given with a forward slash, ``/``, as a directory separator.

docs/codeql/codeql-language-guides/hash-consing-and-value-numbering.rst

@@ -54,7 +54,7 @@ The value numbering library exposes its interface primarily through the ``GVN``
 
 To get the ``GVN`` of an ``Expr``, use the ``globalValueNumber`` predicate.
 
-.. note::
+.. pull-quote:: Note
 
     While the ``GVN`` class has ``toString`` and ``getLocation`` methods, these are only provided as debugging aids. They give the ``toString`` and ``getLocation`` of an arbitrary ``Expr`` within the set.
 
@@ -90,7 +90,7 @@ The hash consing API
 
 The hash consing library exposes its interface primarily through the ``HashCons`` class. Each instance of ``HashCons`` represents a set of expressions within one function that have the same syntax (including referring to the same variables). To get an expression in the set represented by a particular ``HashCons``, use the ``getAnExpr()`` member predicate.
 
-.. note::
+.. pull-quote:: Note
 
     While the ``HashCons`` class has ``toString`` and ``getLocation`` methods, these are only provided as debugging aids. They give the ``toString`` and ``getLocation`` of an arbitrary ``Expr`` within the set.
 

docs/codeql/ql-language-reference/annotations.rst

@@ -203,7 +203,8 @@ change this definition. In this case, ``hasName`` should be final:
 
 **Available for**: |classes|
 
-.. important::
+.. pull-quote:: Important
+
    This annotation is deprecated. Instead of annotating a name with ``library``, put it in a
    private (or privately imported) module.
 

docs/codeql/ql-language-reference/evaluation-of-ql-programs.rst

@@ -96,7 +96,9 @@ To do this, you can use the following mechanisms:
    :ref:`binds <predicate-binding>` all its arguments.
    Therefore, if you :ref:`call <calls>` a predicate on a variable, the variable becomes bound.
 
-   .. important:: If a predicate uses non-standard binding sets, then it does **not** always bind
+   .. pull-quote:: Important 
+      
+      If a predicate uses non-standard binding sets, then it does **not** always bind
       all its arguments. In such a case, whether the predicate call binds a specific argument
       depends on which other arguments are bound, and what the binding sets say about the
       argument in question. For more information, see ":ref:`binding-sets`."

docs/codeql/ql-language-reference/expressions.rst

@@ -552,7 +552,8 @@ The following table lists some examples of different forms of ``any`` expression
 | ``any(int i | i = [0 .. 3] | i * i)``    | the integers ``0``, ``1``, ``4``, and ``9``     |
 +------------------------------------------+-------------------------------------------------+
 
-.. note::
+.. pull-quote:: Note
+
    There is also a `built-in predicate <ql-language-specification#non-member-built-ins>`_
    ``any()``. This is a predicate that always holds.
 

docs/codeql/ql-language-reference/formulas.rst

@@ -318,7 +318,8 @@ The following query selects files that are not HTML files.
     where not f.getFileType().isHtml()
     select f
 
-.. note:: 
+.. pull-quote:: Note 
+
    You should be careful when using ``not`` in a recursive definition, as this could lead to
    non-monotonic recursion. For more information, ":ref:`non-monotonic-recursion`."
 

docs/codeql/ql-language-reference/predicates.rst

@@ -55,7 +55,8 @@ When defining a predicate, you should specify:
    argument type and an identifier for the argument variable.
 #. The predicate body itself. This is a logical formula enclosed in braces. 
 
-.. note::
+.. pull-quote:: Note
+
    An :ref:`abstract` or :ref:`external` predicate has no body. To define such a predicate, 
    end the predicate definition with a semicolon (``;``) instead.
 

docs/codeql/ql-language-reference/types.rst

@@ -366,7 +366,9 @@ value, namely 2.
 It inherits member predicates from ``OneTwo`` and ``TwoThree``. It also (indirectly) inherits
 from ``OneTwoThree`` and ``int``.
 
-.. note:: If a subclass inherits multiple definitions for the same predicate name, then it
+.. pull-quote:: Note
+
+   If a subclass inherits multiple definitions for the same predicate name, then it
    must :ref:`override <overriding-member-predicates>` those definitions to avoid ambiguity.
    :ref:`Super expressions <super>` are often useful in this situation.
 
@@ -397,7 +399,9 @@ in the characteristic predicate of a class.
 Algebraic datatypes
 *******************
 
-.. note:: The syntax for algebraic datatypes is considered experimental and is subject to
+.. pull-quote:: Note
+
+   The syntax for algebraic datatypes is considered experimental and is subject to
    change. However, they appear in the `standard QL libraries <https://github.com/github/codeql>`_
    so the following sections should help you understand those examples.
 

docs/codeql/writing-codeql-queries/index.rst

@@ -12,5 +12,5 @@ Get to know more about queries and learn some key query-writing skills by solvin
 .. toctree::
    :hidden:
 
-   ql-tutorials
    codeql-queries
+   ql-tutorials