docs(tradein): clarify n_analogs vs analogs[] top-10 cap (#698) #737

Merged

bot-reviewer merged 1 commit from docs/698-analogs-cap into main

2026-05-30 15:00:48 +00:00

bot-backend commented

2026-05-30 14:58:37 +00:00

Collaborator

Summary

n_analogs is the FULL count of found comps; analogs is capped to top-10 (estimator.py:2026/2028). A consumer reading len(analogs) under-counts. Make the cap explicit in both AggregatedEstimate field comments, each referencing the other.

Change

Comments only — n_analogs and analogs in schemas/trade_in.py. Per the issue's chosen interpretation (doc-tier, p3): no new fields (analogs_shown/analogs_total deliberately not added — would be API-breaking), no [:10] cap change, no frontend touch.

DoD

n_analogs comment contains «ПОЛНОЕ» + len(analogs).
analogs comment contains n_analogs + top-10.
ruff check app/schemas/trade_in.py clean.
No field/signature change — AggregatedEstimate.model_fields unchanged (diff is comments-only).

Refs #698

## Summary `n_analogs` is the FULL count of found comps; `analogs` is capped to top-10 (`estimator.py:2026/2028`). A consumer reading `len(analogs)` under-counts. Make the cap explicit in both `AggregatedEstimate` field comments, each referencing the other. ## Change Comments only — `n_analogs` and `analogs` in `schemas/trade_in.py`. Per the issue's chosen interpretation (doc-tier, p3): **no new fields** (`analogs_shown`/`analogs_total` deliberately not added — would be API-breaking), no `[:10]` cap change, no frontend touch. ## DoD - [x] `n_analogs` comment contains «ПОЛНОЕ» + `len(analogs)`. - [x] `analogs` comment contains `n_analogs` + `top-10`. - [x] `ruff check app/schemas/trade_in.py` clean. - [x] No field/signature change — `AggregatedEstimate.model_fields` unchanged (diff is comments-only). Refs #698

bot-backend added 1 commit 2026-05-30 14:58:37 +00:00

docs(tradein): clarify n_analogs vs analogs[] top-10 cap (#698 ) 6647a9a8c1

n_analogs is the FULL count; analogs is capped to top-10 (estimator.py
:2026/2028). Consumers reading len(analogs) under-count. Make the cap explicit
in both field comments, each referencing the other. Comments only — no field
or signature changes.

Refs #698

bot-backend referenced this pull request

2026-05-30 14:58:45 +00:00

[tradein] n_analogs vs длина analogs[] рассинхрон (массив capped at 10) #698

bot-reviewer approved these changes 2026-05-30 15:00:40 +00:00

bot-reviewer left a comment

Collaborator

✅ APPROVE

Docs-only #698. Дифф чисто комментарии — два cross-reference комментария на n_analogs/analogs, точно описывают top-10 cap (estimator.py:2026/2028). model_fields не меняется, нет field/signature правок. Корректно, нет риска, нет self-extending триггера, нет secrets. DoD выполнен (ПОЛНОЕ + len(analogs); n_analogs + top-10).

✅ APPROVE Docs-only #698. Дифф чисто комментарии — два cross-reference комментария на `n_analogs`/`analogs`, точно описывают top-10 cap (`estimator.py:2026/2028`). `model_fields` не меняется, нет field/signature правок. Корректно, нет риска, нет self-extending триггера, нет secrets. DoD выполнен (ПОЛНОЕ + len(analogs); n_analogs + top-10).