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

Fix links/refs in js docs #8378

Merged
merged 1 commit into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/clients/js/queries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,9 @@ To exclude the generated files, add the following lines to your ``.gitignore`` f
Writing Queries with Parameters
-------------------------------

To inject external values into your EdgeQL queries, you can use `parameters </docs/edgeql/parameters>`__.
To inject external values into your EdgeQL queries, you can use :ref:`parameters <ref_eql_params>`.

When using the queries generator, you may be tempted to declare the same parameter in multiple places.
However, it's better practice to declare it once by assigning it to a variable in a `with block </docs/edgeql/with#query-parameters>`__
However, it's better practice to declare it once by assigning it to a variable in a :ref:`with block <ref_eql_with_params>`
and reference that variable in the rest of your query. This way you avoid mismatched types in your declarations,
such as forgetting to mark them all as `optional </docs/edgeql/parameters#optional-parameters>`__.

Check out the `EdgeQL docs </docs/edgeql/index>`__ to learn more about writing queries.
such as forgetting to mark them all as :ref:`optional <ref_eql_params_optional>`.
2 changes: 1 addition & 1 deletion docs/clients/js/select.rst
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ fact that they will only occur in certain objects.
Detached
--------

Sometimes you need to "detach" a set reference from the current scope. (Read the `reference docs <ref_edgeql_with_detached>`_ for details.) You can achieve this in the query builder with the top-level ``e.detached`` function.
Sometimes you need to "detach" a set reference from the current scope. (Read the :ref:`reference docs <ref_edgeql_with_detached>` for details.) You can achieve this in the query builder with the top-level ``e.detached`` function.

.. code-block:: typescript

Expand Down
2 changes: 2 additions & 0 deletions docs/edgeql/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ properties.
};


.. _ref_eql_params_optional:

Optional parameters
-------------------

Expand Down
1 change: 1 addition & 0 deletions docs/edgeql/with.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Avengers.
...
}

.. _ref_eql_with_params:

Query parameters
^^^^^^^^^^^^^^^^
Expand Down