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

lib: location: Update documentation #19727

Merged
merged 2 commits into from
Jan 8, 2025

Conversation

tokangas
Copy link
Contributor

@tokangas tokangas commented Jan 2, 2025

Added a limitation in the library documentation. GNSS API should not be used directly by the application when Location library is used. Doing so may lead to unexpected behavior, because GNSS may be in a different state than expected by the library.

@tokangas tokangas requested a review from trantanen January 2, 2025 12:53
@tokangas tokangas requested a review from a team as a code owner January 2, 2025 12:53
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 2, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 2, 2025

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: f2be28aeb7e308b1d448e3d5aee6ec7205c5384f

more details

sdk-nrf:

PR head: f2be28aeb7e308b1d448e3d5aee6ec7205c5384f
merge base: 9abba2029b75e5b4f8990f7b55b28817ed01a0e1
target head (main): bb55a3b33c01869a60aa078a8d145f0a16228e58
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 (6)
doc
│  ├── nrf
│  │  ├── libraries
│  │  │  ├── modem
│  │  │  │  │ location.rst
│  │  │  ├── networking
│  │  │  │  ├── nrf_cloud_agnss.rst
│  │  │  │  │ nrf_cloud_pgps.rst
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  ├── release-notes-1.6.0.rst
│  │  │  │  │ release-notes-1.7.0.rst
samples
│  ├── cellular
│  │  ├── gnss
│  │  │  │ README.rst

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_positioning
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_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • 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.

@tokangas tokangas force-pushed the location_gnss_api_doc_update branch from a22e9f8 to 8192f46 Compare January 7, 2025 08:58
@tokangas tokangas added the DNM label Jan 7, 2025
@tokangas tokangas force-pushed the location_gnss_api_doc_update branch from 8192f46 to 8e54d7f Compare January 8, 2025 10:50
@tokangas tokangas requested review from a team as code owners January 8, 2025 10:50
Copy link
Contributor

@peknis peknis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a nit.

Added a limitation in the library documentation. GNSS API should
not be used directly by the application when Location library is used.
Doing so may lead to unexpected behavior, because GNSS may be in
a different state than expected by the library.

Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>
The title of the GNSS interface documentation has been changed.
Added custom link text to all references.

Signed-off-by: Tommi Kangas <tommi.kangas@nordicsemi.no>
@tokangas tokangas force-pushed the location_gnss_api_doc_update branch from 8e54d7f to f2be28a Compare January 8, 2025 11:40
@tokangas tokangas removed DNM changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 8, 2025
@rlubos rlubos merged commit affcec2 into nrfconnect:main Jan 8, 2025
14 of 15 checks passed
@tokangas tokangas deleted the location_gnss_api_doc_update branch January 9, 2025 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants