Skip to content

Commit be94cc3

Browse files
umapraseedatmon-nordic
authored andcommitted
doc: Doc checks for 2.3.0 release
doc checks for 2.3 release Signed-off-by: Uma Praseeda <[email protected]>
1 parent 2ccb731 commit be94cc3

File tree

12 files changed

+73
-63
lines changed

12 files changed

+73
-63
lines changed

doc/links.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@
4444

4545
.. _`nRF Trace collector`: https://infocenter.nordicsemi.com/index.jsp?topic=%2Fug_trace_collector%2FUG%2Ftrace_collector%2Fintro.html
4646

47+
.. _`coex interface of nRF9160`: https://infocenter.nordicsemi.com/index.jsp?topic=%2Fps_nrf9160%2Fip%2Fradio_lte%2Fdoc%2Fmagpio_if.html
48+
4749
.. ### Source: www.nordicsemi.com
4850

4951
.. _`nRF9160 modem firmware zip file`: https://www.nordicsemi.com/Products/Low-power-cellular-IoT/nRF9160/Download#0B34B59935AF4AFCB7AB93E9646C1F53
@@ -79,6 +81,6 @@
7981

8082
.. _`NMEA report sample`: http://aprs.gids.nl/nmea/#gsa
8183

82-
.. _`Bluetooth Core Specification`: https://www.bluetooth.com/specifications/specs/core-specification/
84+
.. _`Bluetooth Core Specification`: https://www.bluetooth.com/specifications/specs/core-specification-5-4/
8385

8486
.. _`Appropriate Language Mapping Table`: https://www.bluetooth.com/language-mapping/Appropriate-Language-Mapping-Table

lc3/CHANGELOG.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Changelog
44
#########
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
All notable changes to this project are documented on this page.
711

812
nRF Connect SDK v2.2.0

mpsl/doc/bluetooth_coex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Interface
9696
**********
9797

9898
The 1-wire protocol lets Bluetooth LE nRF chips coexist alongside an LTE device on a separate chip.
99-
It was specifically designed for the `coex interface of nRF9160 <https://infocenter.nordicsemi.com/index.jsp?topic=%2Fps_nrf9160%2Fip%2Fradio_lte%2Fdoc%2Fmagpio_if.html>`_.
99+
It was specifically designed for the `coex interface of nRF9160`_.
100100

101101

102102
Hardware resources

nfc/CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Changelog
99

1010
All notable changes to this project are documented in this file.
1111

12-
main branch
12+
Main branch
1313
***********
1414

1515
Added

nrf_modem/doc/at_interface.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The following snippet shows how to use :c:func:`nrf_modem_at_printf` to send a f
8787
}
8888
8989
Any return value other than zero indicates an error.
90-
Negative values indicate that the Modem library has failed to send the AT command, and they represent a nrf_errno code that indicates the reason for the failure.
90+
Negative values indicate that the Modem library has failed to send the AT command, and they represent an ``nrf_errno`` code that indicates the reason for the failure.
9191
Positive values indicate that the modem has received the AT command and has responded with an error.
9292
When a positive value is returned, the error type can be retrieved using the :c:func:`nrf_modem_at_err_type` helper function, and the error value (in case of CME or CMS errors) can be retrieved with the :c:func:`nrf_modem_at_err` helper function.
9393

nrf_modem/doc/delta_dfu.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Limitations
3434

3535
The size of the scratch area can be retrieved with the :c:func:`nrf_modem_delta_dfu_area` function, which returns the size of the area in bytes.
3636
A limitation of delta updates is that the size of the update must not exceed the area of flash memory that a given modem firmware version has dedicated for this operation.
37-
The size of this area varies for any given modem firmware version and it can be retrieved with the Modem library :c:func:`nrf_modem_delta_dfu_area` function.
37+
The size of this area varies for any given modem firmware version and it can be retrieved with the Modem library's :c:func:`nrf_modem_delta_dfu_area` function.
3838
In general, this function can be useful when the size of the largest delta update that can be received needs to be reported to an external service, for example an LwM2M server.
3939
In practice, the application does not use this function in the normal update process, since all delta update files that are part of the `nRF9160 modem firmware zip file`_ are guaranteed to fit in the scratch area of the modem firmware version that they apply to.
4040

nrf_modem/doc/fault_handling.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Modem fault handling
44
####################
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
The application core and the modem core are separate cores on the nRF9160 SiP.
711
When the modem core on the nRF9160 SiP crashes, it sends a fault signal to the application core.
812

@@ -43,7 +47,7 @@ Socket APIs that require communication with the modem, return ``-1`` and set ``e
4347
Although the modem has crashed, any data which was stored by the Modem library, including data that was delivered to the Modem library by the modem, remains available until the Modem library is shut down.
4448
This includes incoming network data, which was received before the crash but has not been read by the application.
4549
The application can read that data as normal, using the :c:func:`recv` function.
46-
When no more data is available, the :c:func:`recv` returns ``-1`` and sets ``errno`` to ``NRF_ESHUTDOWN``.
50+
When no more data is available, the :c:func:`recv` function returns ``-1`` and sets ``errno`` to ``NRF_ESHUTDOWN``.
4751

4852
Ongoing API calls
4953
*****************

nrf_modem/doc/sockets.rst

Lines changed: 52 additions & 52 deletions
Large diffs are not rendered by default.

nrf_modem/include/nrf_modem_os.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ void nrf_modem_os_busywait(int32_t usec);
9696
*
9797
* @param context Library context.
9898
* @param[in, out] timeout Timeout in milliseconds, or @c NRF_MODEM_OS_FOREVER for no timeout.
99-
* Specifies the timeout value on input and the remainig
99+
* Specifies the timeout value on input and the remaining
100100
* time to sleep on output.
101101
*
102102
* @retval 0 The thread is woken before the timeout expired.

softdevice_controller/limitations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Limitations
66
When working with the SoftDevice Controller, you should be aware of the following limitations.
77
In addition, see :ref:`nrf:known_issues` for temporary issues that will be fixed in future releases.
88

9-
DRGN-17562: One of the LE Transmit Power Reporting Event may not be reported to the host.
9+
DRGN-17562: One of the LE Transmit Power Reporting Events might not be reported to the host.
1010
When multiple LE Transmit Power Reporting Events are generated at the same time for the same PHY, one of these events will be missed.
11-
This will only occur when there are simultaneous remote and local power level changes on the same PHY.
11+
This will occur only when there are simultaneous remote and local power level changes on the same PHY.
1212

1313
YOPAN-87: The RSSI value reported by the SoftDevice Controller requires additional temperature compensation
1414
The RSSI value reported by the SoftDevice Controller is the raw value from the radio peripheral.

0 commit comments

Comments
 (0)