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

nrf_modem: doc: Change GNSS interface name #1628

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

tokangas
Copy link
Contributor

@tokangas tokangas commented Jan 7, 2025

Changed GNSS interface name in documentation from Global Satellite Navigation System to GNSS. The name of the interface in modemlib is GNSS and in general all documentation refers to GNSS interface or GNSS API.

Changed GNSS interface name in documentation from
"Global Satellite Navigation System" to "GNSS". The name of the
interface in modemlib is "GNSS" and in general all documentation
refers to "GNSS interface" or "GNSS API".

Signed-off-by: Tommi Kangas <[email protected]>
@tokangas
Copy link
Contributor Author

tokangas commented Jan 7, 2025

@eivindj-nordic @lemrey The title of the gnss_interface.rst was changed in a dectphy PR (#1325), which I have missed because I wasn't asked for a review. I noticed this now, because I added a reference to it.

I created this PR to change the name from "Global Navigation Satellite System" to "GNSS", but actually I think the name should be reverted back to what it was earlier, i.e. "GNSS interface". The page describes the GNSS interface/API, not GNSS. All references to that page are also affected. For example, the meaning here has changed:

https://github.com/nrfconnect/sdk-nrf/blob/741cb7aa25da073966de033ca9d79788e2fc6a0b/doc/nrf/libraries/modem/location.rst?plain=1#L35

That used to be "Uses GNSS interface for getting the location", but now it says "Uses Global Navigation Satellite System for getting the location". That is not the same thing.

I guess the purpose of the change was to align the naming, but I don't think the current way is good. I don't know if there are similar problems with references to the other interface documents.

@eivindj-nordic
Copy link
Contributor

Looking at where it is used in documentation I think it should either be changed to GNSS interface, or we should update the documentation where it is used to add interface after the reference. I don't have a strong opinion of what is best.

@tokangas
Copy link
Contributor Author

tokangas commented Jan 7, 2025

We had a call with Emanuele and agreed that we'll go with "GNSS". I'll update the references in the SDK.

@tokangas tokangas requested a review from a team January 7, 2025 12:51
@rlubos rlubos merged commit 37a87d3 into nrfconnect:main Jan 7, 2025
5 checks passed
@tokangas tokangas deleted the doc_rename_gnss_interface branch January 7, 2025 13:49
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.

5 participants