Remove AI-generated jargon from comments [No QA] - #98062
Conversation
Replace 'fan out', 'sentinel', 'defense in depth', and similar AI-generated terms with plain English throughout source and test files. - 'fan out' → 'make'/'send'/'update' - 'sentinel' (in prose comments) → 'placeholder'/'entry'/'guard entry' - 'defense in depth' → 'extra guard' - UNDEFINED_SENTINEL constant renamed to UNDEFINED_PLACEHOLDER - Variable `sentinel` in useSyncModalWithHistory renamed to `guardEntry`
|
@jasperhuangg Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
Codecov Report✅ Changes either increased or maintained existing code coverage, great job!
|
|
No product review needed |
|
Skipping C+ review and checklist because this is mostly a bunch of comment changes. |
|
🚧 marcaaron has triggered a test Expensify/App build. You can view the workflow run here. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Deployed to staging by https://github.com/marcaaron in version: 9.4.53-0 🚀
|
|
🤖 No help site changes required. I reviewed the changes in this PR against Expensify's help site content under Why no docs update is neededEvery change is internal and non-behavioral:
The help site documents customer-facing product behavior, and none of that is affected here. Accordingly, I did not create a draft help site PR. @marcaaron, please review the linked help site PR and confirm it reflects the current behavior. Then mark the linked help site PR (Note: no help site PR was created because no docs changes are required — see above.) |
Explanation of Change
Replaces AI-generated jargon in comments and docstrings with plain English throughout source and test files. No logic changes — only comment text and one constant/variable rename.
Changes made:
fan out→make/send/update(LoadTestState, SearchUpdate, test comments)defense in depth→extra guard(crashDiagnostics)sentinel(in prose comments) →placeholder/entry/guard entry(navigation, modal history, violations, transactions, etc.)UNDEFINED_SENTINELconstant renamed toUNDEFINED_PLACEHOLDERincompoundParamsKey.tssentinelinuseSyncModalWithHistory/index.tsrenamed toguardEntryFunction names that use "sentinel" as part of their API (
isModalHistorySentinel,getTrailingStringSentinels,stripTrailingModalSentinels) are unchanged to avoid a breaking API rename.Fixed Issues
$
PROPOSAL:
Tests
npm run testand verify all unit tests pass (no logic was changed)npm run typecheck-tsgoOffline tests
N/A — comment-only changes, no behavior change.
QA Steps
N/A — comment-only changes, no user-visible behavior change.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari