Skip to content

[candidate-miner] Antora attribute jackson-docs is defined but never referenced in the docs #8

Description

@github-actions

What is wrong

The Antora attributes file defines a documentation attribute jackson-docs,
but nothing in the documentation tree ever references it. An attribute that is
never used with {jackson-docs} in any .adoc page is dead configuration: it
adds a line a maintainer has to reason about while contributing nothing to the
rendered docs.

Where

  • File: framework-docs/antora.yml
  • Line (advisory): 65
  • Occurrence: jackson-docs: '(fasterxml.github.io/redacted)'

Evidence

config_kind:             antora_attribute
pattern:                 jackson-docs
raw_line:                jackson-docs: '(fasterxml.github.io/redacted)'
value:                   '(fasterxml.github.io/redacted)'
matches_nothing_in_tree: true
names_a_literal:         true
extractor (miner):       config_dead_entry v1.0.0
score:                   75 (config_kind_prior=40, names_a_literal=25, single_line_fix=10, staleness_years=0)

Suggested fix

Remove the unused jackson-docs attribute line. Since no page references it,
removing the definition is the fix. The docs team may prefer to handle it their
own way (for example, if they intend to add a page that uses it), so treat this
as a starting point rather than a prescribed patch.

How to verify the fix

From tools/candidate-miner/, run the miner and confirm this fingerprint is no
longer emitted:

./miner.py run --miner config_dead_entry --dry-run

Provenance

Mined at commit 008199fe0fa0e93ec85a458bf0585445bb97532e.

candidate-miner:fingerprint sha256:9a7f993ecf86fead1ac33667b1efa577dc0c7415f4dc0f4ff51c4da627438327

Generated by Candidate scan: file mined candidates as issues · opus48 · 86.5 AIC · ⌖ 30.3 AIC · ⊞ 4.7K ·

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions