Ch4s3 / bandera

93%

main: 93%

Pull #12

github

docs: fix correctness errors, fill missing @doc, align terminology

Critical correctness fixes:
- Flag.enabled?/2 doc omitted schedule gates from the no-:for evaluation path
- Gate.new/2 doc only listed "empty map" as a variant raise condition; also
  raises on all-zero or negative weights
- variant/2 docs (Bandera + Flag modules) didn't mention for: nil returns default

Factual fixes:
- features_guide.md opener incorrectly claimed all write functions accept by:;
  put_variants/3 and put_segment/2 do not support it
- put_variants/3 doc now notes the third argument is ignored and not audited
- Constraint moduledoc example replaced with a positive coercion example
- README variant/2 nil-return conditions updated to include missing for: case
- README "variations" → "variants" for consistency with the API

Terminology and consistency:
- features_guide.md "resolved at evaluation time" → "expanded" (matches expand_segments/1)
- features_guide.md :matches table row now notes it is unanchored
- "variations" → "variants" in both README and features guide

Missing @doc on public API:
- Bandera.Constraint: @doc for new/3 and match?/2; @doc false for to_map/1, from_map/1
- Bandera.Usage: @doc for start_link/1, attach/0, detach/0, last_evaluated/1
- Bandera.Gate: examples added to prerequisite?/1 and schedule?/1; InvalidTargetError
  moduledoc updated to cover variant validation errors

2 of 2 new or added lines in 1 file covered. (100.0%)

1018 of 1092 relevant lines covered (93.22%)

280.16 hits per line