docs(android): refresh the notification and background-service docs (WT-1139) - #365
Merged
Conversation
…line with the code The two documents describing the notification system and the call notification services still described a design several reworks old: a builder and channel set that no longer exists, a manager facade with different method signatures, and service lifecycles from before the answered-call notification handoff. Both documents now describe what the code actually does, including how the active-call notification is started, updated and stopped, how the incoming-call notification steps back once the call in progress has its own, and the known way an active-call notification can be left behind after the system kills the app mid-call.
…docs A verification review of the refreshed documents caught ten places where the new text still told the story wrong: the shared call list was attributed to the wrong OS process, Telecom registration to the wrong component, the hang-up button to data it does not actually use, the looping ringtone to a mechanism that is silent, and the ring-or-vibrate choice as ring-and-vibrate. It also caught statements the rewrite had left behind: an API table with a method that no longer exists and outdated signatures, the disappearance of the service's safety-net timeouts, and a notification channel left with no documented producer. All ten are corrected against the sources.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
The documents describing the notification system and the two call notification services had fallen behind the code by several reworks: they listed builders and channels that no longer exist, a manager facade with different methods, and service lifecycles from before the answered-call notification handoff.
Both documents now match the current behavior: how the active-call notification is started, updated and stopped, how the incoming-call notification is silenced after the answer and steps back once the call in progress has a notification of its own, and the known way an active-call notification can be left behind when the system kills the app mid-call. Every statement was verified against the sources before writing.
Documentation only, no code changes.