peczenyj / GDPR-IAB-TCFv2 / 25561678220

96%

main: 96%

push

github

docs: align POD and error messages with implementation (#99)

Bundle of small doc/code mismatches found while reviewing the v0.400
release. None of these change runtime behaviour for callers passing
documented arguments; they fix POD that lied about the implementation
and error messages that referred to the wrong type or unit.

BitUtils.pm
- Drop the =head2 get_char6 block (no such sub exists; no caller).
- get_char6_pair: drop the "sequence size n" framing -- the impl is
  fixed at 2 chars. Drop the trailing ", 2" from the example call;
  the third arg was silently ignored.
- Add =head2 get_uint3 (already implemented and exported, used by
  PublisherTC for segment-type decoding).
- get_uint36 example: $created = $deciseconds/10, not /2.

Publisher.pm
- publisher_tc: drop unused $callback from the signature.
- TO_JSON example: "custom_purpose" -> "custom_purposes" to match
  the key actually emitted by PublisherTC::TO_JSON.

PublisherTC.pm
- SYNOPSIS: $publisher_tc->num_custom_purposes (was a bareword);
  drop the check_restriction example (that method lives on the
  Publisher wrapper, not here).
- Fix "requir'ements" typo.
- TO_JSON: scope description to purposes (the impl returns
  consents/legitimate_interests/custom_purposes only -- restrictions
  are emitted by PublisherRestrictions::TO_JSON, and the combined
  view is in Publisher::TO_JSON). Drop the spurious restrictions
  block from the example and fix custom_purpose -> custom_purposes.

PublisherRestrictions.pm
- TO_JSON POD: clarify the inner value is the integer
  restriction_type (0/1/2), not always 1 -- the impl has stored
  int($restriction_type) since this method was added.

RangeSection.pm
- "a BitField for vendor consent strings using RangeSections" ->
  "a RangeSection"; "31 bytes" -> "31 bits" (data is the unpacked
  bitstring, threshold compares against bit count).
- Three "range entry exclusion" -> "range entry inclusion" (TCF v2
  range entries describe inclusion, not exclusion).... (continued)

5 of 5 new or added lines in 2 files covered. (100.0%)

1058 of 1104 relevant lines covered (95.83%)

7845.72 hits per line