Skip to content

Commit b970178

Browse files
peknisrlubos
authored andcommitted
doc: style fixes, stop using “we”
In many docs, there are style violations using “we” as the subject. Cleaned up them. Signed-off-by: Pekka Niskanen <[email protected]>
1 parent 4754116 commit b970178

File tree

22 files changed

+30
-32
lines changed

22 files changed

+30
-32
lines changed

applications/nrf_desktop/doc/dvfs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ You can configure each DVFS state using the following Kconfig options:
7979
Some of the tracked application states have associated events that inform when the state is turned on and off (for example, USB connection).
8080
Other states have associated application events emitted periodically when active.
8181
There is no event explicitly informing that state is no longer active (for example, config channel).
82-
For such states, we need to define a timeout that is used to turn off the tracked state after associated application events are no longer emitted.
82+
For such states, you need to define a timeout that turns off the tracked state after associated application events are no longer emitted.
8383

8484
Frequency change retry
8585
======================

doc/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_quick_start.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It covers essential concepts, practical steps for implementation, and references
1919
Learning resources
2020
******************
2121

22-
In case you do not have experience with bootloaders, we recommend going through the following learning resources first:
22+
In case you do not have experience with bootloaders, read through the following learning resources first:
2323

2424
* `Bootloaders and DFU/FOTA`_ - The page is a part of the `Nordic Developer Academy`_ courses and offers is an introduction to bootloaders, DFU, and various transport features available in the |NCS|.
2525
* `Adding Device Firmware Update (DFU/FOTA) Support in nRF Connect SDK`_ - The webinar provides an overview of fundamental principles and best practices for adding DFU/FOTA support in an nRF Connect SDK-based firmware.
@@ -55,7 +55,7 @@ Explore MCUboot functionality using the samples provided.
5555
Note that some samples are located in the `sdk-nrf`_ repository, while others are in `sdk-zephyr`_.
5656
All supported samples are regularly tested to ensure reliability.
5757

58-
We recommend beginning with the :zephyr:code-sample:`smp-svr` sample and using :ref:`zephyr:mcu_mgr` for interaction from a host.
58+
It is recommended to begin with the :zephyr:code-sample:`smp-svr` sample and use :ref:`zephyr:mcu_mgr` for interaction from a host.
5959
This setup supports both UART and Bluetooth® LE connections.
6060

6161
The following samples are supported:
@@ -112,7 +112,7 @@ Supported features and configurations
112112

113113
MCUboot is a customizable bootloader designed to meet specific requirements.
114114
This page outlines the tested configurations.
115-
For production builds, we recommend using the same set of configurations.
115+
For production builds, it is recommended to use the same set of configurations.
116116

117117
The following table is an overview of the currently supported bootloaders:
118118

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_custom_pcb.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Prepare your PCB
1414

1515
First, you need to create your PCB for the nRF54H20 SoC.
1616

17-
We highly recommend using the PCB layouts and component values provided by Nordic Semiconductor, especially for clock and power sources, considering the following limitations:
17+
It is highly recommended to use the PCB layouts and component values provided by Nordic Semiconductor, especially for clock and power sources, considering the following limitations:
1818

1919
* The DC/DC inductor must be present on the PCB for any of the supported power schemes.
2020
Use one of the following power supply options:

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_customize_qsg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For this quick start guide, you need the following development kit:
6161
Software requirements
6262
=====================
6363

64-
For this quick start guide, we will install the following software:
64+
For this quick start guide, install the following software:
6565

6666
* The full |NCS| toolchain.
6767
See :ref:`ug_nrf54h20_gs` for instructions on how to install the toolchain.

doc/nrf/app_dev/device_guides/nrf70/wifi_advanced_security_modes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ To build the hostapd executable, complete the following steps:
120120
# RADIUS clients configuration
121121
radius_server_clients=hostapd.radius_clients
122122
radius_server_auth_port=1812
123-
# Enable eap_server when we use hostapd integrated EAP server instead of external RADIUS authentication
123+
# Enable eap_server when using hostapd integrated EAP server instead of external RADIUS authentication
124124
eap_server=1
125125
# EAP server user database
126126
eap_user_file=hostapd.eap_user_tls

doc/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,7 @@ liblwm2m_carrier 0.6.0
960960

961961
Initial public release for modem firmware version 1.0.1.
962962
This release is intended to let users begin the integration on the Verizon Wireless device management platform and start the certification process with Verizon Wireless.
963-
We recommend upgrading to the next release when it becomes available.
963+
It is recommended to upgrade to the next release when it becomes available.
964964
The testing performed on this release does not meet Nordic standard for mass production release testing.
965965

966966

doc/nrf/libraries/security/trusted_storage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ The trusted storage library can only be used on a build without Trusted Firmware
170170
This means that you must use a board target without :ref:`security by separation <ug_tfm_security_by_separation>` (``/cpuapp``).
171171
When you build for ``/cpuapp``, you build the firmware for the application core without Cortex-M Security Extensions (CMSE) and so without TF-M.
172172
The library can be used directly on such a build to store important assets.
173-
However, for cryptographic keys we suggest to use the `PSA functions for key management`_.
173+
However, for cryptographic keys, use the `PSA functions for key management`_.
174174
These APIs will internally use this library to store persistent keys.
175175

176176
Dependencies

doc/nrf/protocols/bt/bt_mesh/overview/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Transport encryption
5151

5252
As an example, consider a mesh network deployed in a hotel.
5353
In this example it is desirable to limit some features that are to be controlled by the staff (like configuration of key cards or access to storage areas), and some features to be available to guests (like controlling room lighting or air conditioning).
54-
For this, we can have one application key for the guests and one for the staff, allowing the messages to be relayed across the same network, while preventing the guests and the staff from reading each other's messages.
54+
For this, you can have one application key for the guests and one for the staff, allowing the messages to be relayed across the same network, while preventing the guests and the staff from reading each other's messages.
5555

5656
While application keys are used to separate access rights to different applications in the network, the device keys are used to manage devices in the network.
5757

doc/nrf/protocols/matter/end_product/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Watch the following video for an overview of the Matter end product development
1919
</h1>
2020

2121
The pages that follow deal with the preparation of the device for market launch, starting with :ref:`ug_matter_device_prerequisites` and the reference to the :ref:`ug_matter_device_factory_provisioning` guide.
22-
Finally, we discuss topics related to Matter certification (:ref:`ug_matter_device_attestation`, :ref:`ug_matter_device_dcl`, :ref:`ug_matter_device_certification`, :ref:`ug_matter_ecosystems_certification`, :ref:`ug_matter_device_configuring_cd`, and :ref:`ug_matter_test_event_triggers`) and :ref:`ug_matter_device_bootloader`.
22+
Also, topics related to Matter certification (:ref:`ug_matter_device_attestation`, :ref:`ug_matter_device_dcl`, :ref:`ug_matter_device_certification`, :ref:`ug_matter_ecosystems_certification`, :ref:`ug_matter_device_configuring_cd`, and :ref:`ug_matter_test_event_triggers`) and :ref:`ug_matter_device_bootloader` are covered.
2323

2424
.. toctree::
2525
:maxdepth: 1

doc/nrf/protocols/matter/getting_started/adding_clusters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ Create a callback for sensor activation and deactivation
303303

304304
Handlers for the ``Sensor Activate`` and ``Sensor Deactivate`` tasks are now ready, but the tasks are not posted to the task queue.
305305
The sensor is supposed to be turned on and off remotely by changing the ``OnOff`` attribute of the On/off cluster, for example using the Matter controller.
306-
This means that we need to implement a callback function to post one of these tasks every time the ``OnOff`` attribute changes.
306+
This means that you need to implement a callback function to post one of these tasks every time the ``OnOff`` attribute changes.
307307

308308
To implement the callback function, complete the following steps:
309309

0 commit comments

Comments
 (0)