Skip to content

docs: dangling docs/code-review/09-provider-azure.md reference in Azure converter.go:50 #26

Description

@cristim

Problem

providers/azure/internal/recommendations/converter.go:50 references a documentation file that does not exist in the repository:

// in docs/code-review/09-provider-azure.md.

git ls-files docs/code-review/ returns nothing, and git log --all --diff-filter=A -- 'docs/code-review/*' shows no commits ever added that path. The reference is a dangling pointer to documentation that was never tracked (likely because of the docs/ blanket gitignore the now-merged PR LeanerCloud/cloud-commitments-cli#1211 fixed -- the doc lived only in the verifier's local working tree and could never be staged).

Now that docs/ is no longer blanket-ignored, the inconsistency is visible: readers chasing the M1/M2 finding for the Scope field land on a 404.

Fix options (pick one)

  1. Add the referenced file -- commit docs/code-review/09-provider-azure.md if the original review write-up is recoverable from the verifier's working tree.
  2. Remove the reference -- edit the comment at converter.go:50 to drop the trailing See finding M1/M2 in docs/code-review/09-provider-azure.md. sentence. The preceding three sentences already convey the design intent.

Option 2 is the safer default if the review document is not at hand; the comment loses nothing essential without that pointer.

Evidence

$ git grep -n 'docs/code-review' -- '*.go' '*.md' '*.yml'
providers/azure/internal/recommendations/converter.go:50:	// in docs/code-review/09-provider-azure.md.

$ git ls-files docs/code-review/
(no output)

$ git log --all --diff-filter=A -- 'docs/code-review/*'
(no output)

Why this matters

The PR LeanerCloud/cloud-commitments-cli#1211 fix removed the gitignore trap that was hiding docs/code-review/. Pre-existing dangling references like this one were invisible before; now they show up to anyone reading the Azure recommendation code looking for the cited write-up. Small hygiene fix, no functional risk.

No activity

Activity on this issue will appear here.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions