▸case-01 In our FastAPI service `orders_service`, we changed the path parameter `order_id` from an integer to a UUID string in `routers/orders.py`. A colleague suggests leaving the OpenAPI spec as-is since FastAPI autogenerates OpenAPI schemas dynamically at runtime, but our team publishes a committed static `openapi.yaml` file for external SDK generation. How should the static `openapi.yaml` file be updated for the `GET /orders/{order_id}` path? | pass→pass | 14,901 | 10,519 | -29% | 1 | 1 | 0% | 1,704 | 1,206 | -29% | 0 | 0 | — |
▸case-02 In `packages/core/src/auth.ts`, we refactored the exported function `authenticateUser(token: string, options?: AuthOptions)` to rename `token` to `accessToken` and made `options` mandatory (`options: AuthOptions`). The existing JSDoc comment still documents `[@param token]` as optional. How should the JSDoc `@param` tags be updated to reflect the new function signature? | pass→pass | 5,486 | 5,215 | -5% | 1 | 1 | 0% | 1,046 | 984 | -6% | 0 | 0 | — |
▸case-03 In repository `payment-gateway-node`, PR #142 removed the deprecated `chargeWithToken()` method from the `PaymentClient` class. Someone suggested adding this change under the `[Fixed]` section of `CHANGELOG.md` because it cleans up technical debt. Following the Keep a Changelog 1.0.0 specification, under which section should this breaking removal be documented? | fail→pass | 3,997 | 3,694 | -8% | 1 | 1 | 0% | 724 | 725 | +0% | 0 | 0 | — |
▸case-04 In the Go CLI project `db-migrator`, we added a new command-line flag `--max-connections` (short flag `-c`, default `10`) to the `db-migrator run` command in `cmd/run.go`. The main `README.md` includes a CLI Usage table listing flags, descriptions, defaults, and shorthand versions. How should `README.md` be updated to reflect this CLI addition? | pass→pass | 6,393 | 4,156 | -35% | 1 | 1 | 0% | 1,263 | 809 | -36% | 0 | 0 | — |
▸case-05 In `pkg/config/database.go`, the Go struct `DatabaseConfig` previously had an unexported field `maxIdleConns int`. We capitalized it to export `MaxIdleConns int`. The existing package level GoDoc comment above `DatabaseConfig` lists exported fields with brief explanations. How should the GoDoc comment be updated? | pass→pass | 9,570 | 5,634 | -41% | 1 | 1 | 0% | 1,150 | 1,071 | -7% | 0 | 0 | — |
▸case-06 In `analytics/metrics.py`, function `calculate_churn_rate()` was changed from returning a float scalar to returning a custom `ChurnResult` dataclass containing `rate` and `confidence_interval`. A developer suggests leaving the Google-style docstring unchanged since Python uses dynamic typing. How should the `Returns:` block of the function's docstring be updated for Sphinx documentation generation? | pass→pass | 9,391 | 8,776 | -7% | 1 | 1 | 0% | 1,671 | 1,614 | -3% | 0 | 0 | — |
▸case-07 In `services/notification-service`, we updated `config.ts` to load a new mandatory environment variable `REDIS_CLUSTER_URL` and removed the legacy `REDIS_HOST` variable. The project maintains `.env.example` as documentation for local configuration. How should `.env.example` be synchronized with these code changes? | pass→pass | 8,617 | 4,262 | -51% | 1 | 1 | 0% | 1,534 | 843 | -45% | 0 | 0 | — |
▸case-08 In our Terraform AWS S3 module `terraform-aws-s3-bucket`, we added a new required input variable `kms_master_key_id` of type `string` without a default value in `variables.tf`. The repository uses automated documentation tooling to render `README.md`. Someone suggested manually creating a custom markdown section for this variable. What is the standard practice for synchronizing `README.md` when variable definitions in `variables.tf` change? | fail→pass | 16,144 | 10,330 | -36% | 1 | 1 | 0% | 1,822 | 1,814 | -0% | 0 | 0 | — |
▸case-09 In Rust crate `http-client`, we added a new variant `TooManyRequests(u64)` to the public `enum HttpError` in `src/errors.rs`. The crate's `src/lib.rs` and module Rustdoc comments explain all error variants with `///` doc comments and code examples. How should the Rustdoc documentation be synchronized? | pass→pass | 11,740 | 9,666 | -18% | 1 | 1 | 0% | 2,241 | 1,829 | -18% | 0 | 0 | — |
▸case-10 In `schema.graphql` for `user-service`, field `phoneNumber` on type `User` is being deprecated in favor of `phoneNumbers: [PhoneNumber!]!`. A junior developer suggests deleting `phoneNumber` immediately from the GraphQL schema file. How should `schema.graphql` be updated to notify clients while preserving backwards compatibility? | pass→pass | 8,951 | 4,599 | -49% | 1 | 1 | 0% | 1,641 | 784 | -52% | 0 | 0 | — |
▸case-11 In Helm chart `charts/redis-cluster`, we changed `replicaCount` default from 3 to 5 in `values.yaml` and added a new key `persistence.storageClass`. The repository uses comment annotations in `values.yaml` to maintain chart documentation in `README.md`. How should the chart documentation be synchronized after editing `values.yaml`? | pass→pass | 10,343 | 8,714 | -16% | 1 | 1 | 0% | 1,949 | 1,636 | -16% | 0 | 0 | — |
▸case-12 In Python library `math_utils/core.py`, function `square_root(x)` was modified to raise `ValueError` instead of returning `None` when `x < 0`. The function's docstring contains a Python doctest block showing `square_root(-1)` returning `None`. If CI runs doctest execution, what will happen and how must the docstring example be updated? | pass→pass | 7,506 | 6,673 | -11% | 1 | 1 | 0% | 1,347 | 1,213 | -10% | 0 | 0 | — |
▸case-13 In `proto/v1/inventory.proto`, we added a new gRPC RPC method `CheckStock(StockRequest) returns (StockResponse)` to service `InventoryService`. What documentation synchronization step is needed inside `inventory.proto` before generating documentation from the proto schema? | pass→pass | 8,660 | 4,589 | -47% | 1 | 1 | 0% | 1,516 | 803 | -47% | 0 | 0 | — |
▸case-14 In `docs/api/endpoints.md`, after refactoring route handlers in `server.js` from `/v1/users/login` to `/v2/auth/login`, internal anchor links and endpoint relative links in markdown documentation broke. What doc synchronization workflow step should be executed or verified in CI to catch broken documentation links? | pass→pass | 10,967 | 6,170 | -44% | 1 | 1 | 0% | 1,847 | 998 | -46% | 0 | 0 | — |
▸case-15 In `services/billing`, PR #305 refactored the monolith's billing module into an asynchronous event-driven architecture using Kafka, rendering `docs/architecture/decisions/0004-monolithic-transactions.md` obsolete. A developer suggests editing `0004-monolithic-transactions.md` to erase the old decision and replace its content with the new Kafka design. Following Architecture Decision Record (ADR) standards, how should the ADR documentation be synchronized? | pass→pass | 8,313 | 7,018 | -16% | 1 | 1 | 0% | 1,521 | 1,323 | -13% | 0 | 0 | — |
▸case-16 In `db/migrations/20240315_add_subscriptions.sql`, we added a new table `subscriptions` with foreign keys to `users` and `plans`. The team maintains a database ERD diagram in `docs/db_schema.md` using Mermaid.js syntax. How should `docs/db_schema.md` be synchronized with this migration? | pass→pass | 8,375 | 5,674 | -32% | 1 | 1 | 0% | 1,719 | 1,120 | -35% | 0 | 0 | — |
▸case-17 In `src/config/flags.ts`, we introduced a new feature flag `ENABLE_NEW_CHECKOUT_FLOW` gated for 20% rollout, and removed the retired flag `LEGACY_PAYMENT_V1`. The team maintains `docs/feature_flags.md` listing active flags, descriptions, and statuses. How should `docs/feature_flags.md` be updated? | pass→pass | 12,663 | 7,045 | -44% | 1 | 1 | 0% | 1,494 | 987 | -34% | 0 | 0 | — |
▸case-18 In `packages/sdk/src/types.ts`, we added an optional field `timeoutMs?: number` to the interface `ClientConfig`. TypeDoc is used to generate HTML API documentation from TypeScript source files. A developer forgot to run doc generation after updating the code. How should the TypeDoc generation process be synchronized when TypeScript interface definitions change? | fail→pass | 10,454 | 6,454 | -38% | 1 | 1 | 0% | 1,878 | 1,442 | -23% | 0 | 0 | — |
▸case-19 In `src/components/Header.tsx`, React UI text was updated to change string key `header.welcome_back` to `header.greeting_user` and added a new string key `header.logout_confirm`. The translation file `locales/en/translation.json` still contains the old keys. How should `locales/en/translation.json` be synchronized with `Header.tsx`? | pass→pass | 9,531 | 3,788 | -60% | 1 | 1 | 0% | 1,450 | 750 | -48% | 0 | 0 | — |
▸case-20 In `package.json`, PR #88 bumped the version from `1.4.2` to `2.0.0` due to removing exported helper functions in `index.js`. The package README includes an installation snippet `npm install my-lib@^1.0.0` and a compatibility matrix table. How should the documentation in `README.md` be synchronized with this major version bump? | pass→pass | 13,183 | 6,369 | -52% | 1 | 1 | 0% | 1,584 | 1,059 | -33% | 0 | 0 | — |
▸case-21 In `src/utils/sort.ts`, we refactored `quickSort()` to use a dual-pivot partitioning algorithm to improve execution time. The function signature, parameter names, and public API interface remain completely unchanged. What updates are required for the public API documentation or JSDoc `@param` tags? | fail→fail | 6,701 | 6,321 | -6% | 1 | 1 | 0% | 1,192 | 1,041 | -13% | 0 | 0 | — |
▸case-22 In `pkg/auth/session.go`, we added an unexported private helper function `validateInternalHash(data []byte) bool` to perform internal checksum validation. It is not exposed outside the `auth` package and does not affect exported types or package API. What updates are required in `README.md` or exported GoDoc documentation? | pass→pass | 8,430 | 4,762 | -44% | 1 | 1 | 0% | 801 | 834 | +4% | 0 | 0 | — |
▸case-23 In `services/user.py`, a developer ran code formatting tools to reformat indentation and imports without altering any function signatures, parameter names, docstrings, or API schemas. What documentation synchronization steps should be performed? | pass→pass | 11,128 | 4,780 | -57% | 1 | 1 | 0% | 1,090 | 720 | -34% | 0 | 0 | — |