QuantEcon / QuantEcon/data-lectures
Batch rename for the §5.1 generic filenames, paired with their prose edits
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 58m
- Merged PRs (30d)
- 18
Description
This is the dedicated issue that decision D6 in QuantEcon/workspace-lectures#39 promised ("a batch rename across all five §5.1 files gets its own issue") and that the QuantEcon/workspace-lectures#42 validation confirmed had still not been filed after three separate promises. The register entry at #66 (decision 5, "the rename list for generic filenames") carries the same list; this issue is where the work gets planned and tracked.
The published tree is flat, so the key is a bare filename. From .dev/qeld/migration-catalog.md §5.1, the five names and where each now stands:
| file | origin | problem | status now |
|---|---|---|---|
fp.dta |
python.myst | two letters | already migrated and published under the generic name (Track B, D6 kept all seven names as-is; no collision today since lectures/ holds no other .dta) |
fred_data.csv |
advanced | names a source, not a dataset | not yet migrated — rename at migration |
test_pwt.csv |
programming | "test" | not yet migrated — rename at migration |
acs_data_summary.csv |
advanced | plausible but claims a whole survey | not yet migrated — rename at migration |
data.csv |
programming (about_py.md) |
referenced but never exists | nothing to rename — the dangling reference is the fix |
Two constraints the catalog already records:
- A rename breaks text qeld cannot reach. The catalog's example is
mle.md's prose namingmle/fp.dta; every rename must be paired with its prose/{download}edits in the same PR, found by grep rather than by the audit (§5.2 lists 28 prose refs, 11 naming a data file in two places). - Timing: the catalog wants this pass done before the remaining tracks migrate — that now means before Tracks C and D land their files, so the three unmigrated names arrive under their final names rather than needing a second breaking change.
For fp.dta, renaming now means a breaking URL change and a coordinated repoint wave for one file. The cheap alternative is to fold it into the Phase 4 interim→final cutover (QuantEcon/data-lectures#15), where every consumer URL changes anyway — proposed default, decide here.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .dev/qeld/migration-catalog.md §5.1 and the prose references listed in §5.2; use grep to find filenames and {download} links, then review QuantEcon/data-lectures#15 for the fp.dta timing. Done means deciding replacement names, renaming the three pending files, fixing the dangling data.csv reference, and updating every affected prose reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100