Skip to content

[good first issue]🎯 docs: config comments disagree with actual defaults — l2DelayAfterL1Seconds off by 9x #161

@MuBeiGe

Description

@MuBeiGe

Summary

Three config fields in the source have comments that disagree with the actual code defaults.

Field Comment says Actual default
maxScenes default: 20 ?? 15
l2DelayAfterL1Seconds default: 90 ?? 10
report.enabled default: true ?? false

Impact

l2DelayAfterL1Seconds is off by 9x (comment says 90 seconds, code uses 10). Users who rely on the comment to understand pipeline timing will have incorrect mental model. For example, expecting a 90-second delay between L1 and L2 processing when the actual delay is only 10 seconds.

Evidence

Seen in v0.3.6 src/ source comments vs dist/index.mjs actual ?? fallback values.

Suggested Fix

Update the source comments to match the actual defaults (or update defaults to match comments, whichever the maintainers intended).

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions