Skip to content

Commit 4b69a38

Browse files
FrancescoSerrlubos
authored andcommitted
doc: general doc update using VALE
Updated docs to fix VALE-triggered errors. Signed-off-by: Francesco Domenico Servidio <[email protected]>
1 parent dc1ee19 commit 4b69a38

File tree

120 files changed

+313
-304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+313
-304
lines changed

applications/hpf/mspi/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Key functions, such as :c:func:`hrt_write`, :c:func:`hrt_tx`, and :c:func:`hrt_r
255255
3. Transfers the frame elements sequentially via :c:func:`hrt_tx`.
256256
4. Manages clock timing and CE pin behavior.
257257
* - :c:func:`hrt_tx`
258-
- Handles the low-level data transfer for a specific frame element (e.g., ``command``, ``address``, ``dummy_cycles``, or ``data``).
258+
- Handles the low-level data transfer for a specific frame element (for example, ``command``, ``address``, ``dummy_cycles``, or ``data``).
259259
- 1. Configures the shift controller (:c:func:`nrf_vpr_csr_vio_shift_ctrl_buffered_set`).
260260
2. Writes each word from the data buffer to the output register.
261261
3. Starts the hardware counter for generating clock signal.

applications/machine_learning/app_desc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -660,7 +660,7 @@ Forwarding data.
660660

661661
a. Open the `nRF Connect for Mobile`_ application and connect to the device again.
662662
#. Bond with the device from the `nRF Connect for Mobile`_ application on your smartphone or tablet.
663-
#. Find **Nordic UART Service** and enable notification of its "TX Characteristic".
663+
#. Find :guilabel:`Nordic UART Service` and enable notification of its :guilabel:`TX Characteristic`.
664664
#. Observe the sensor readouts represented as comma-separated values.
665665
Every new value represents a single sensor readout.
666666

applications/matter_bridge/doc/matter_bridge_description.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,12 +434,14 @@ CONFIG_BRIDGE_TEMPERATURE_SENSOR_BRIDGED_DEVICE
434434
.. _CONFIG_BRIDGE_MIGRATE_PRE_2_7_0:
435435

436436
CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
437-
``bool`` - Enable migration of bridged device data stored in old scheme from pre |NCS| 2.7.0 releases.
437+
``bool`` - Enable migration of bridged device data stored in old scheme from pre |NCS| 2.7.0 releases.
438438

439439
.. _CONFIG_BRIDGE_MIGRATE_VERSION_1:
440440

441441
CONFIG_BRIDGE_MIGRATE_VERSION_1
442-
``bool`` - Enable migration of bridged device data stored in version 1 of new scheme.If you selected the simulated device implementation using the :ref:`CONFIG_BRIDGED_DEVICE_SIMULATED <CONFIG_BRIDGED_DEVICE_SIMULATED>` Kconfig option, also check and configure the following option:
442+
``bool`` - Enable migration of bridged device data stored in version 1 of new scheme.
443+
444+
If you selected the simulated device implementation using the :ref:`CONFIG_BRIDGED_DEVICE_SIMULATED <CONFIG_BRIDGED_DEVICE_SIMULATED>` Kconfig option, also check and configure the following option:
443445

444446
.. _CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_IMPLEMENTATION:
445447

applications/nrf_desktop/description.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ The assignments of hardware interface elements depend on the device type.
696696

697697
1. Short-press to toggle between available peers.
698698
**LED1** blinks rapidly for each peer.
699-
The amount of blinks corresponds to the number assigned to a peer: one blink for peer 1, two blinks for peer 2, and so on.
699+
The amount of blinks corresponds to the number assigned to a peer (for example, one blink for peer 1, two blinks for peer 2), increasing incrementally with each peer.
700700
#. Double-press to confirm the peer selection.
701701
The peer is changed after the confirmation.
702702
**LED1** becomes solid for a short time and then turns itself off.

applications/nrf_desktop/doc/config_channel.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ For reading the module descriptor, the following conditions must be met:
364364
* The module name should be provided as the first string in the module descriptor.
365365
* The following strings should indicate the module option names.
366366
The first option on the descriptor must be identified with Option ID equal to ``1``.
367-
The following options will be identified by monotonically increasing Option ID values (second option by ``2``, third by ``3``, and so on).
367+
The following options will be identified by monotonically increasing Option ID values, starting from ``2`` for the second option, ``3`` for the third, and continuing incrementally.
368368
* Once the descriptor is read, the module options can be accessed.
369369
When performing a set or fetch request on the option, the Event ID contains the Option ID and the Module ID of the module that owns the option.
370370

@@ -406,8 +406,8 @@ Depending on the connection method:
406406
To prevent HID input report rate drop while forwarding config channel report set operation, nRF Desktop Dongle can forward the data using GATT write without response.
407407
In that case, the peripheral does not have to provide the GATT write response instead of sending the HID input report.
408408

409-
The "GATT write without response" operation cannot be performed on the HID feature report.
410-
To allow the "GATT write without response", the Peripheral must provide an additional HID output report.
409+
The *GATT write without response* operation cannot be performed on the HID feature report.
410+
To allow the GATT write without response, the Peripheral must provide an additional HID output report.
411411
Use the :ref:`CONFIG_DESKTOP_CONFIG_CHANNEL_OUT_REPORT <config_desktop_app_options>` Kconfig option in the nRF Desktop peripheral configuration to add the mentioned HID output report.
412412
Disabling this option reduces the memory consumption.
413413

applications/serial_lte_modem/doc/SMS_AT_commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ This is the notification syntax when an SMS message is received:
4949

5050
* The ``<datetime>`` value is a string.
5151
It represents the time when the SMS is received.
52-
It has a format of "YY-MM-DD HH:MM:SS".
52+
It has a format of ``YY-MM-DD HH:MM:SS``.
5353
* The ``<number>`` value is a string.
5454
It represents the SMS sender's phone number.
5555
* The ``<text>`` value is a string.

applications/serial_lte_modem/doc/SOCKET_AT_commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ Response syntax
439439

440440
* The ``<sec_tag>`` value is an integer.
441441
It indicates to the modem the credential of the security tag to be used for establishing a secure connection.
442-
For a non-secure socket, it returns the value of -1.
442+
For a non-secure socket, it returns the value of 1.
443443

444444
* The ``<ranking>`` value is an integer.
445445
It indicates the ranking value of this socket, where the largest value means the highest ranking.

applications/serial_lte_modem/doc/slm_description.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ The following configuration files are provided:
333333

334334
* :file:`overlay-ppp-without-cmux.overlay` - Devicetree overlay that configures the UART to be used by PPP.
335335
This configuration file should be included when building SLM with PPP and without CMUX, in addition to :file:`overlay-ppp.conf`.
336-
It can be customized to fit your configuration (UART, baud rate, and so on).
336+
It can be customized to fit your configuration, such as UART settings, baud rate, and flow control.
337337
By default, it sets the baud rate of the PPP UART to 1 000 000.
338338

339339
* :file:`overlay-memfault.conf` - Configuration file that enables `Memfault`_.

applications/serial_lte_modem/doc/slm_testing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1323,7 +1323,7 @@ Complete the following steps to test the functionality provided by the :ref:`SLM
13231323
226 Transfer complete.
13241324
OK
13251325
1326-
#. Navigate to the :file:`upload` folder, switch to binary transfer mode, and create a binary file with the content "DEADBEEF".
1326+
#. Navigate to the :file:`upload` folder, switch to binary transfer mode, and create a binary file with the content ``DEADBEEF``.
13271327

13281328
.. parsed-literal::
13291329
:class: highlight
@@ -1342,7 +1342,7 @@ Complete the following steps to test the functionality provided by the :ref:`SLM
13421342
226 Transfer complete.
13431343
OK
13441344
1345-
#. Switch to ASCII transfer mode and create a text file with the content "TEXTDATA".
1345+
#. Switch to ASCII transfer mode and create a text file with the content ``TEXTDATA``.
13461346

13471347
.. parsed-literal::
13481348
:class: highlight
@@ -1366,7 +1366,7 @@ Complete the following steps to test the functionality provided by the :ref:`SLM
13661366
221 Goodbye.
13671367
OK
13681368
1369-
#. Test an FTP connection to "ftp.dlptest.com".
1369+
#. Test an FTP connection to ``ftp.dlptest.com``.
13701370

13711371
This server does not support anonymous login.
13721372
Go to `DLPTest.com`_ to get the latest login information.
@@ -1441,7 +1441,7 @@ Complete the following steps to test the functionality provided by the :ref:`SLM
14411441
250 OK. Current directory is /newfolder
14421442
OK
14431443
1444-
#. Switch to binary transfer mode and create a binary file with the content "DEADBEEF".
1444+
#. Switch to binary transfer mode and create a binary file with the content ``DEADBEEF``.
14451445

14461446
.. parsed-literal::
14471447
:class: highlight

doc/nrf/app_dev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Application development
77
The user guides in this section cover topics related to the general processes governing the application development in the |NCS|, from :ref:`creating an application <create_application>` to its customization for a specific device.
88
Read these guides together with Zephyr's :ref:`zephyr:application` documentation.
99

10-
For detailed integration instructions of specific technologies and components, check the pages in other top sections of the documentation (Protocols, Applications, Samples, and so on).
10+
For detailed integration instructions of specific technologies and components, check the pages in other top sections of the documentation (like Protocols, Applications, or Samples).
1111

1212
.. figure:: /images/ncs_app_dev.svg
1313
:alt: Application development section overview

0 commit comments

Comments
 (0)