docs(qdp): drop dead ADDING_INPUT_FORMATS.md links from readers README#1307
Open
bearomorphism wants to merge 1 commit into
Open
docs(qdp): drop dead ADDING_INPUT_FORMATS.md links from readers README#1307bearomorphism wants to merge 1 commit into
bearomorphism wants to merge 1 commit into
Conversation
qdp/docs/readers/README.md referenced ../ADDING_INPUT_FORMATS.md in two places, but that file has never existed. lychee.toml carried an explicit exclude with a 'TODO: fix the links in this file' note because of these. Mirror the treatment already used by the published page docs/qdp/readers.md, which softens the same dangling reference to a plain-text 'ADDING_INPUT_FORMATS.md (TODO)' marker rather than a broken link. This keeps the placeholder visible to anyone looking to write the extension guide later, without leaving a 404 in the link checker. Also drop ./qdp/docs/readers/README.md from lychee.toml exclude_path so the link checker covers it again. Verified locally with lychee 0.24.2: Before: 2 file-not-found errors on ../ADDING_INPUT_FORMATS.md After: 0 errors on qdp/docs/readers/README.md (--config lychee.toml) Pre-commit (end-of-file-fixer, trailing-whitespace) clean. Refs apache#1285 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
checking the git history about ADDING_INPUT_FORMATS.md |
Contributor
Author
|
ok it looks just a placeholder for me |
Member
|
Not sure of this file ever existed before, but it(ADDING_INPUT_FORMATS.md) looks like should be in issue list not in file. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Slice (A) from #1285 (per the status comment).
qdp/docs/readers/README.mdhas two markdown links to../ADDING_INPUT_FORMATS.md— a file that has never existed in the repo (see history below).lychee.tomlcarried an explicit exclude with aTODO: fix the links in this filenote because of these.Why
docs/qdp/readers.md) had already chosen the right pattern for this — a plain-textADDING_INPUT_FORMATS.md (TODO)marker — so the in-source README was the inconsistent one.History — did
ADDING_INPUT_FORMATS.mdever exist?No. The placeholder was committed without the target file ever being written, and was then propagated forward by routine docs work. Verified:
git log --all --full-history --diff-filter=AD -- "**/ADDING_INPUT_FORMATS*"→ 0 commits: no commit ever added or deleted such a file.git log --all -S "ADDING_INPUT_FORMATS" --reverseshows where the string entered the repo and how it spread:9780d955a(PR #753)qdp/docs/readers/README.mdwith the broken[../ADDING_INPUT_FORMATS.md](../ADDING_INPUT_FORMATS.md)references and aADDING_INPUT_FORMATS.md # Extension guideentry in the file-organization tree. First and only origin of the string.b736eb90d(PR #914)docs/qdp/readers.md, propagating the placeholder into the published site.dee2170bc930c0a3fe(PR #1040)version-0.4/version-0.5snapshots.So the link was a forward-looking pointer to an extension guide that the original author intended to write but never did. Two and a half releases later, it's still a
TODO. Rather than block this PR on writing the guide, this fix matches what the published page already does — keep the placeholder visible as plain text — and unblocks the link checker.How
qdp/docs/readers/README.md— replace the two dead[../ADDING_INPUT_FORMATS.md](../ADDING_INPUT_FORMATS.md)markdown links with`ADDING_INPUT_FORMATS.md` (TODO)plain text, matchingdocs/qdp/readers.mdlines 142 and 226. The placeholder remains visible to anyone who wants to write the extension guide later, but is no longer a broken link.lychee.toml— drop./qdp/docs/readers/README.mdfromexclude_path(and itsTODO: fix the links in this filecomment) so CI''s link checker covers the file again.Out of scope (left to @ryankert01 or follow-ups):
ADDING_INPUT_FORMATS.mdcontent.docs/qdp/readers.md↔qdp/docs/readers/README.mdduplication / "File Organization" stale tree.Verification
Reproduced and verified locally with
lychee 0.24.2.Before:
After (with project config so the new exclude_path is honoured):
(0 total because the only links in this file were the broken ones; the rewritten markers are now plain text. Nothing else in the README points outward.)
Pre-commit (
end-of-file-fixer,trailing-whitespace) passes on the changed files.Refs #1285