Skip to content

Commit fe4d0cc

Browse files
DOCSP-14265 document Include Driver Syntax for all languages (#340)
1 parent 91e0f3f commit fe4d0cc

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed
Loading

source/includes/steps-export-pipeline-to-language.yaml

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ref: select-export-language
2929
content: |
3030
3131
In the :guilabel:`Export Pipeline To:` dropdown, select your desired
32-
language:
32+
programming language:
3333
3434
.. figure:: /images/compass/agg-builder-export-lang-select.png
3535
:figwidth: 720px
@@ -38,23 +38,37 @@ content: |
3838
The :guilabel:`My Pipeline` pane on the left displays your
3939
pipeline in :manual:`mongo shell <mongo>` syntax.
4040
41-
The pane to the right displays your pipeline in the language
42-
selected.
41+
The pane to the right displays your pipeline in the selected
42+
programming language.
4343
---
4444
title: Include import statements, if desired.
45+
optional: true
4546
level: 4
4647
ref: include-import-statements
4748
content: |
48-
*(Optional)*: Check the :guilabel:`Include Import Statements` option
49-
to include the required import statements for the language selected.
49+
Check the :guilabel:`Include Import Statements` option
50+
to include the required import statements for the selected programming language.
5051
---
51-
title: Click :guilabel:`Copy`.
52+
title: Include driver syntax, if desired.
53+
optional: true
54+
level: 4
55+
ref: include-driver-syntax
56+
content: |
57+
Check the :guilabel:`Include Driver Syntax` option to include
58+
application code for the selected programming language. If you
59+
include driver syntax, the copyable code reflects :ref:`project
60+
<query-bar-project>`, :ref:`sort <query-bar-sort>`, :ref:`maxtimems
61+
<query-bar-max-time-ms>`, :ref:`collation <query-bar-collation>`,
62+
:ref:`skip <query-bar-skip>` and :ref:`limit <query-bar-limit>`
63+
options.
64+
---
65+
title: Click :icon-fa4:`files-o`.
5266
level: 4
5367
ref: click-copy
5468
content: |
55-
Click the :guilabel:`Copy` button at the top-right of the pipeline
56-
to copy the pipeline for the selected language to your clipboard.
57-
You can now integrate and execute your created pipeline into your
69+
Click :icon-fa4:`files-o` at the top-right of the pipeline to copy
70+
the pipeline for the selected programming language to your clipboard.
71+
You can now integrate and execute your created pipeline into your
5872
application.
5973
---
6074
title: Click :guilabel:`Close`.

0 commit comments

Comments
 (0)