ruby-grape / grape / 34716314708

99%

push

github

Correct code comments that no longer match the code (#2938)

A pass over every comment under lib/ against the code it describes, with
each correction kept short.

Behaviour the comments got wrong, checked by running it:
- A `requires` without a type is not coerced; String is not a default.
- `desc` takes keyword options only; a positional Hash raises rather than
  being deprecated.
- A namespace requirement that is not met leaves the route unmatched
  (404), not a 422.
- The param versioner sets no version when none is passed, and neither it
  nor the path versioner rewrites the path.
- The formatter is chosen by the negotiated format, not by a Content-Type
  header set in the endpoint.
- The `sendfile` and `collection_coercer_for` examples raise as written.
- MultipleTypeCoercer coerces one value of several types, not an Array.
- InheritableSetting#stacked and #inheritable_values can hand back the
  root scope's own store, not the calling scope's.
- Grape::API does respond to `inheritable_setting`.

Docs attached to the wrong thing, or naming what no longer exists:
- The `rescue_from` description sat above META_RESCUE_SELECTORS, so YARD
  gave it to the constant; the constant now comes first.
- The positional-Hash `@deprecated` tag moves from `declare` to
  `legacy_options?`.
- `build_with` no longer lists the removed Grape::Extensions builders.
- Helpers are included into a subclass, not the singleton class;
  AsValidator is never dispatched; `#namespace_start` does not exist.
- The YARD params of ParamsScope.new, `given`, `declared`, `route_param`
  and the coercers match their signatures.

Plus smaller corrections and typos.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>

1347 of 1393 branches covered (96.7%)

Branch coverage included in aggregate %.

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

4108 of 4108 relevant lines covered (100.0%)

26782.73 hits per line