chore: replace internal short-code markers in test comments with plain descriptions#88
Merged
OmarAlJarrah merged 2 commits intoJun 16, 2026
Conversation
Several committed test comments carried review-style short-code prefixes (e.g. "H4", "M6", "L3", "B14") that have no meaning outside the review that produced them. This strips those prefixes while keeping the explanatory text, and rewrites the few headers/sentences that read awkwardly once the code was removed so each comment stands on its own. Comment-only change across sdk-core, sdk-io-okio3, sdk-transport-okhttp, and sdk-transport-jdkhttp test sources; no test names, assertions, logic, or public API are affected.
…markers-from-test-comments # Conflicts: # sdk-transport-jdkhttp/src/test/kotlin/org/dexpace/sdk/transport/jdkhttp/JdkHttpTransportTest.kt
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.
Summary
A number of committed test files carried terse short-code markers in their comments (identifiers like
H1,M3,L6,V2-4) that were only meaningful in the context they were written in and convey nothing to a reader of the test today.This rewrites those comments to describe what each test actually covers, or drops the bare marker token where the comment reads fine without it, across 13 test files in
sdk-core,sdk-io-okio3, and the two transport modules.Comments only — no test names, assertions, logic, or test data were changed. One token that looks like a marker but is real test data (a hex byte value
0xE9) was deliberately left untouched. All affected modules build and their test suites pass.Closes #19