Skip to content

Remove internal short-code markers from committed test comments #19

Description

@OmarAlJarrah

Several test comments carry internal short-code markers (// L1:, // M6:, // H4, // M7, // H1:, // L3:, // M4:) that have no meaning outside the review that produced them. They appear in, among others:

  • sdk-core/src/test/.../http/pipeline/steps/RetryStepTest.kt
  • sdk-core/src/test/.../http/response/LoggableResponseBodyTest.kt
  • sdk-core/src/test/.../io/TeeSinkTest.kt
  • sdk-core/src/test/.../http/pipeline/steps/RedirectStepTest.kt
  • sdk-core/src/test/.../http/pipeline/steps/AsyncInstrumentationStepTest.kt
  • sdk-transport-okhttp/src/test/.../OkHttpTransportTest.kt

The explanatory text after each marker is good and should stay; only the [HML][0-9]-style prefixes are noise. Committed test comments should be self-contained and free of these identifiers.

Action

Strip the short-code prefixes from test comments, keeping the descriptive text.

Introduced on fix/http-stack-correctness-resource-safety (#13).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions