Skip to content

fix: correct broken links, typos, and grammar in Generic Extractor docs (PRDCT-365 audit) - #398

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782146121-PRDCT-365-audit-fixes
Closed

fix: correct broken links, typos, and grammar in Generic Extractor docs (PRDCT-365 audit)#398
Iamfle4ka wants to merge 1 commit into
mainfrom
devin/1782146121-PRDCT-365-audit-fixes

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Jira issue(s): PRDCT-365

Changes:

Unambiguous fixes from the PRDCT-365 developers-docs audit of /extend/generic-extractor/. All 3 needs_human items (A4: backoff formula, A5: retryConfig sample, A6: zendesk.response.url) are excluded — zero needs_human rows in this diff.

Code-accuracy fixes (Block A):

  • A1 pagination/index.md: Fix broken link — offset methods pointed to .../pagination/pagenum/ instead of .../pagination/offset/
  • A2 pagination/index.md: Remove stray ] after [EX139] markdown link
  • A3 pagination/index.md: Fix nextFlagnextPageFlag (matches HasMoreScrollerDecorator.php:39)

Doc-hygiene fixes (Block C):

  • C1 ssh-proxy/index.md: Typo "tu" → "to"
  • C2 ssh-proxy/index.md: Fix sentence fragment between EX131/EX133 links
  • C3 aws-signature/index.md: "signaturing" → "signing"
  • C4 aws-signature/index.md: "extractor sign" → "the extractor signs"
  • C5 config/index.md: Merge broken sentence fragment in userData docs
  • C6 pagination/index.md: Clarify mutually exclusive limitStop params (count/field)

Full audit log with Block 0 (39-page classification), Block A, Block B (verified-accurate), Block C, and summary posted as comment on PRDCT-365."

Link to Devin session: https://app.devin.ai/sessions/4971d8270e1f44c79b2acf4625b5f226
Requested by: @Iamfle4ka

Fixes PRDCT-365

- A1: Fix offset link pointing to pagenum page (pagination/index.md L121)
- A2: Remove stray bracket after EX139 link (pagination/index.md L341)
- A3: Fix nextFlag -> nextPageFlag config property name (pagination/index.md L123)
- C1: Fix typo 'tu' -> 'to' (ssh-proxy/index.md L13)
- C2: Fix sentence fragment between EX131 and EX133 links (ssh-proxy/index.md L94-95)
- C3: Fix grammar 'signaturing' -> 'signing' (aws-signature/index.md L9)
- C4: Fix grammar 'extractor sign' -> 'the extractor signs' (aws-signature/index.md L10)
- C5: Fix broken sentence fragment in userData docs (config/index.md L163-165)
- C6: Clarify mutually exclusive limitStop params (pagination/index.md L240-241)

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@Iamfle4ka Iamfle4ka self-assigned this Jun 22, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@linear

linear Bot commented Jun 22, 2026

Copy link
Copy Markdown

PRDCT-365

@Iamfle4ka
Iamfle4ka marked this pull request as ready for review July 10, 2026 13:53

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: needs_human (risk 2/5) · profile docs

Clean, low-risk docs fixes, but a link target and two product-behaviour claims can't be verified from the diff — route to human.

Concerns:

  • extend/generic-extractor/configuration/api/pagination/index.md: A1 new link target .../pagination/offset/ existence unverifiable at HEAD
  • extend/generic-extractor/configuration/api/pagination/index.md: A3 param rename nextFlag→nextPageFlag is a product-behaviour claim; confirm
  • extend/generic-extractor/configuration/api/pagination/index.md: C6 limitStop count/field requirement change needs product confirmation

Suggested reviewers: @keboola/docs

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded by #410, which carries all four files. One hunk was dropped as a duplicate — the pagenumoffset link, which #402 fixes identically. Open 43 days with no human review.

All three of the bot's concerns are now confirmed:

  • .../pagination/offset/ exists — that hunk rides on PRDCT-480: fix broken links, dead anchors, invalid JSON examples, and typos across the docs #402 rather than here, and the target page is real.
  • nextFlagnextPageFlag. Code search over keboola/generic-extractor: nextPageFlag appears 5 times (README plus the configs of examples 045, 046, 047 and 139); nextFlag appears 0 times. The documented name was never a valid option.
  • limitStop's count / field are conditionally required. The list marked both "(required)" while the next sentence called them mutually exclusive with one required — the page contradicted itself. Upstream settles it: doc/examples/126-pagination-stop-limit/config.json sets {"field": "scroller.count"} alone and 127-pagination-stop-field/config.json sets {"count": 3} alone.

Generic Extractor stays on this site (per DEV-MIGRATION-PLAN.md), so unlike #393 and #396 this PR's content belongs here — it just needed rebasing and deduplicating against #402.

Branch stays cherry-pickable.

@Iamfle4ka Iamfle4ka closed this Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants