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

lwm2m_carrier: doc: glue documentation improvements #19743

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

nordic-hani
Copy link
Contributor

@nordic-hani nordic-hani commented Jan 3, 2025

  • Aligned the use of "retval 0" closer to the NCS codebase style.
  • Corrected some functions which can return a positive integer,
    such as length (as opposed to just "0 If success").
  • Added documentation for some undocumented return values.
  • Minor tweaks for consistendy such as spacing, and ms to milliseconds.

@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 3, 2025
@nordic-hani nordic-hani added the doc-required PR must not be merged without tech writer approval. label Jan 3, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 3, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 7

Inputs:

Sources:

sdk-nrf: PR head: 81165108851bb3d06f84d0dd410f2eb8a2aa362c

more details

sdk-nrf:

PR head: 81165108851bb3d06f84d0dd410f2eb8a2aa362c
merge base: 01b2deb38dd845f10c4b9c3e4bd94030dd9a93db
target head (main): 01b2deb38dd845f10c4b9c3e4bd94030dd9a93db
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (1)
lib
│  ├── bin
│  │  ├── lwm2m_carrier
│  │  │  ├── include
│  │  │  │  │ lwm2m_os.h

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
    • ◻️ test-fw-nrfconnect-nrf-iot_lwm2m
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

@nordic-hani nordic-hani force-pushed the glue_doc_improvements branch from 6f66820 to dd76b38 Compare January 14, 2025 12:47
@github-actions github-actions bot removed the doc-required PR must not be merged without tech writer approval. label Jan 14, 2025
@nordic-hani nordic-hani changed the title Glue doc improvements lwm2m_carrier: doc: glue documentation improvements Jan 15, 2025
@nordic-hani nordic-hani force-pushed the glue_doc_improvements branch from dd76b38 to cbc2ac4 Compare January 15, 2025 11:12
@nordic-hani nordic-hani added doc only and removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 15, 2025
@nordic-hani nordic-hani marked this pull request as ready for review January 15, 2025 11:19
@nordic-hani nordic-hani requested a review from a team as a code owner January 15, 2025 11:19
- Aligned the use of "retval 0" closer to the NCS codebase style.
- Corrected some functions which can return a positive integer,
  such as length (as opposed to just "0 If success").
- Added documentation for some undocumented return values.
- Minor tweaks for consistendy such as spacing, and ms to milliseconds.

Signed-off-by: Håvard Vermeer <[email protected]>
@nordic-hani nordic-hani force-pushed the glue_doc_improvements branch from cbc2ac4 to 8116510 Compare January 23, 2025 13:03
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 23, 2025
@nordic-hani nordic-hani merged commit f36abd1 into nrfconnect:main Jan 23, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants