`migrate_pageobject_headers.py` skips the canonical PageObject header

Open
#118 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
28/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
tooling

Research direction

Start in header_bounds() in living-doc-pageobject-scan/scripts/migrate_pageobject_headers.py, where the two ={10,} rule-line requirement is checked. Run the script over the canonical TypeScript header in living-doc-pageobject-scan/SKILL.md to confirm it is skipped. The issue asks that the canon's header shapes be accepted, but it defers the exact shapes to the linked authored-input issue, so confirm that scope with a maintainer before changing the parser.

Written by the indexing model from the issue text.

Description

type:tech-debt
Description of Technical Debt

header_bounds() in living-doc-pageobject-scan/scripts/migrate_pageobject_headers.py requires two ={10,} rule
lines. So the canonical TypeScript header shown in its own skill (/* LIVING DOC — FEAT-003 · Checkout, with no rule
lines) is not reported at all: a file that needs migrating is passed over. FEAT-UNKNOWN headers are skipped too, and
a status: STUB whose stub-reason: sits on the next line is wrongly flagged for a human.

Impact of Technical Debt
  • Migration silently misses files.
Category

Code Quality / Refactoring

Priority

Low - Nice to have

Proposed Solution

Accept the header shapes the canon accepts, once the authored-input check settles them; fixing it here first would fork the rule between this script and the parsers.

Effort Estimate

Half a day

Dependencies / Related

The "Check authored living-doc input before merge and while typing" issue.

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

Run the script over the header in living-doc-pageobject-scan/SKILL.md (the canonical TypeScript example).

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 14m
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc

All issues in AbsaOSS/living-doc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.