Skip to content

[Changed] Documentation update for improved clarity - #96

Open
eric-murray wants to merge 18 commits into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2
Open

eric-murray wants to merge 18 commits into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2

Conversation

@eric-murray

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

This PR updates the API inline documentation for improved clarity.

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

There are no functional changes introduced by this PR.

Changelog input

 release-note
 - Documentation update for improved clarity

Additional documentation

None

Updated descriptions for clarity and consistency in the API documentation. Adjusted event type definitions and clarified event triggering conditions.
Updated the wording for clarity in the device roaming status subscription documentation.
Updated formatting for terms and definitions in the device roaming status API documentation.
Clarified the description of LastStatusTime to indicate confirmation by the API provider and potential connectivity issues.
Updated definitions for 'Roaming' and 'Device', and added new definition for 'Country'.
Updated the section title and clarified the endpoint description for better understanding.
@eric-murray
eric-murray marked this pull request as draft August 13, 2026 08:17
bigludo7
bigludo7 previously approved these changes Aug 28, 2026

@bigludo7 bigludo7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@eric-murray eric-murray changed the title [Change] Documentation update for improved clarity [Changed] Documentation update for improved clarity Sep 25, 2026
@eric-murray
eric-murray marked this pull request as ready for review September 25, 2026 12:20

@bigludo7 bigludo7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM
Thanks Eric

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants