justinmclean opened a new issue, #407:
URL: https://github.com/apache/airflow-steward/issues/407
## Summary
`tools/dev/check-placeholders.sh` keeps an inline allowlist marker
`"e\.g\."` (a regex-escaped form of `e.g.`) that can never match the
input, because the script compares markers using bash substring matching
rather than regex. Remove the dead entry; the plain `"e.g."` marker on
the line above already covers the intended case.
## Background
`check-placeholders.sh` allowlists certain inline phrases so that an
intentional, explanatory mention of "Airflow" in framework docs does not
trip the hardcoded-references linter. The match is done with bash's
`[[ "$line" == *"$marker"* ]]`, which is a literal substring test: the
two backslashes in `"e\.g\."` are matched as backslashes, not as regex
escapes, so the entry only fires on lines that literally contain
`e\.g\.` (none exist in real prose). The plain-form sibling on the line
above (`"e.g."`) is what actually matches `e.g.` in docs. The dead entry
is probably a leftover from an earlier regex-based version of the
check.
## Where to look
- `tools/dev/check-placeholders.sh` — line 88, the `"e\.g\."` entry in
the `INLINE_ALLOW_MARKERS` array. Lines 82-101 give the full array and
lines 121-129 show the substring-match function.
## Acceptance criteria
- [ ] The `"e\.g\."` entry on line 88 of
`tools/dev/check-placeholders.sh` is removed.
- [ ] Running `tools/dev/check-placeholders.sh` against the repo produces
the same output as before the change (no new false positives, no
new false negatives).
- [ ] A one-line comment near the `INLINE_ALLOW_MARKERS` array notes
that entries are matched as substrings, not regexes, so future
contributors don't reintroduce a regex-escaped form.
## Estimated effort
~30 minutes for someone new to the codebase.
## Getting started
- [Your first
contribution](https://github.com/apache/airflow-steward/blob/main/CONTRIBUTING.md#your-first-contribution)
---
_This issue was drafted with the help of an AI-assisted tool and reviewed by
an airflow-steward maintainer before posting._
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
