Reconcile logging.console defaults across configuration references

Offen Anfängerfreundlich
#769 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 4 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
74/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
markdown, typescript, yaml
Bereich
documentation

Rechercherichtung

Beginne damit, reference/configuration/options.md um Zeile 246 und reference/logging/configuration.md Zeilen 84-94 zu lesen, vergleiche sie dann mit der verlinkten Harper-Quelle bei Commit 9993e3e: harper_logger.ts Zeilen 254-256 und defaultConfig.yaml Zeilen 40-55. Bestätige, dass der Default für die unterstützte Version false ist, wenn der Schlüssel fehlt, und aktualisiere dann die Dokumentation, sodass die Referenzen übereinstimmen; die Schema-Beschreibung in config-root.schema.json ist eine separate, vom Quellcode verantwortete Korrektur. Fertig bedeutet, dass sich die beiden Dokumentationsreferenzen nicht mehr widersprechen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

content

The current references disagree about the default for logging.console:

Public Harper source at 9993e3e supports disabled console capture when this option is absent: the live configuration handler uses logOptions.console ?? false, and defaultConfig.yaml omits the key. The schema description also says true, so it should not be used alone as evidence of the runtime default. This is a source trace, not a test of every released binary.

Confirm the intended supported-version default, then align the current documentation. Coordinate any schema-description correction with its source owner; this tracker does not request a runtime behavior change.

Found while reviewing Document full-text paging and configurable search limits. This pre-existing contradiction is outside that v5.4 full-text update.

P3, effort Low, type Bug: contained documentation contradiction with no observed runtime incident; the correction is bounded to the default references. No matching open documentation epic or committed release was found, so parent and milestone are intentionally unset. No customer-specific or security evidence; private fields and defect-origin fields remain unset.

Review-Deferral: b61768680773482d severity=minor category=documentation

Comment generated by kAIle (GPT-6)

Vorherrschende Sprache
MDX
Sterne
9
Forks
9
Ø Merge
5 T. 5 Std.
Gemergte PRs (30 T.)
48

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus HarperFast/documentation

Alle Issues in HarperFast/documentation

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.