Repository navigation
[No QA] Docs updates for E/A#101181 name singular Download receipt label - #101376
Conversation
Co-authored-by: AHMED <ahmdshrif@users.noreply.github.com>
MelvinBot
added
the
HelpDot
ahmdshrif
left a comment
ahmdshrif
left a comment
There was a problem hiding this comment.
Reviewed against the three call sites in #101181 and the docs match the actual behavior:
- Report More menu: label counts the report's expenses that have a receipt.
- Reports page bulk menu: label counts receipts across the selected reports (not the number of reports).
- Expenses page bulk menu: label counts the selected expenses that have a receipt; deleted expenses are excluded.
The new FAQ entries state the rule correctly and the download itself is unchanged. LGTM.
|
@MelvinBot mark this PR as ready for review |
Concierge reviewer checklist:
For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member? cc @sakluger |
|
@abdulrahuman5196 @sakluger One of you needs to 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] |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| **Download receipts** only appears when at least one selected expense has a receipt attached. If none of the selected expenses have receipts, the option is hidden. | ||
| This action only appears when at least one selected expense has a receipt attached. If none of the selected expenses have receipts, the option is hidden. | ||
|
|
||
| ## Why does the receipt download option sometimes read Download receipt instead of Download receipts? |
There was a problem hiding this comment.
UI referencing violation: "the receipt download option" generalizes the UI element. HELPSITE_NAMING_CONVENTIONS.md ("Do not generalize UI elements") requires the exact UI label. Reference the actual button, e.g. Download receipt / Download receipts, rather than a paraphrased "option".
| **Download receipts** only appears when at least one expense has a receipt attached. In a single report's **More** menu, it appears when that report has an expense with a receipt. When you select multiple reports and open **Selected**, it appears only if at least one selected report has an expense with a receipt. If none of the expenses have receipts, the option is hidden. | ||
| This action only appears when at least one expense has a receipt attached. In a single report's **More** menu, it appears when that report has an expense with a receipt. When you select multiple reports and open **Selected**, it appears only if at least one selected report has an expense with a receipt. If none of the expenses have receipts, the option is hidden. | ||
|
|
||
| ## Why does the receipt download option sometimes read Download receipt instead of Download receipts? |
There was a problem hiding this comment.
UI referencing violation: "the receipt download option" generalizes the UI element. HELPSITE_NAMING_CONVENTIONS.md prohibits generalizing UI elements — reference the exact labels (Download receipt / Download receipts) instead of a paraphrased "option".
| 5. Wait for the files to finish preparing. The zip file downloads automatically when it's ready. If it doesn't, select **Download file** to save it to your device. | ||
|
|
||
| **Note:** **Download receipts** only appears when at least one selected expense has a receipt. Deleted expenses are not included in the download. | ||
| **Note:** This action only appears when at least one selected expense has a receipt. It reads **Download receipt** when exactly one selected expense has a receipt, and **Download receipts** when more than one does. Deleted expenses are not included in the download. |
There was a problem hiding this comment.
Deterministic writing: "This action" is a vague reference to the UI control. Per HELPSITE_NAMING_CONVENTIONS.md (be literal/exact, reference the exact UI label), name the button explicitly, e.g. "Download receipt or Download receipts only appears when at least one selected expense has a receipt."
| 5. Wait for the files to finish preparing. The zip file downloads automatically when it's ready. If it doesn't, select **Download file** to save it to your device. | ||
|
|
||
| **Note:** **Download receipts** only appears when at least one expense on the report has a receipt. | ||
| **Note:** This action only appears when at least one expense on the report has a receipt. It reads **Download receipt** when the report has exactly one receipt, and **Download receipts** when it has more than one. |
There was a problem hiding this comment.
Deterministic writing: "This action" vaguely references the UI control. Per HELPSITE_NAMING_CONVENTIONS.md (be literal/exact, use the exact UI label), name the button explicitly instead of "This action".
| 5. Wait for the files to finish preparing. The zip file downloads automatically when it's ready. If it doesn't, select **Download file** to save it to your device. | ||
|
|
||
| **Note:** **Download receipts** only appears when at least one selected report has an expense with a receipt. | ||
| **Note:** This action only appears when at least one selected report has an expense with a receipt. It reads **Download receipt** when the selected reports hold exactly one receipt in total, and **Download receipts** when they hold more than one. |
There was a problem hiding this comment.
Deterministic writing: "This action" vaguely references the UI control. Per HELPSITE_NAMING_CONVENTIONS.md (be literal/exact, use the exact UI label), name the button explicitly instead of "This action".
HelpDot Documentation ReviewOverall AssessmentThis PR is a targeted help-site follow-up to E/A#101181, updating two articles to name both the singular Download receipt and plural Download receipts labels and to explain the count-based rule that decides which one appears. The changes are small, focused, and correctly scoped to the receipt-download flows. No structural or heading violations are introduced. Scores Summary
Key Findings
Recommendations
Files Reviewed
Note: Detailed line-by-line feedback has been provided as inline comments. |
|
🚀 Deployed to staging by https://github.com/twisterdotcom in version: 9.4.90-0 🚀
|
|
@ahmdshrif Ok to check this off the list if no QA needed? |
|
🚀 Deployed to production by https://github.com/lakchote in version: 9.4.90-2 🚀
Bundle Size Analysis (Sentry): |
stephanieelliott
changed the title
Explanation of Change
Help site follow-up to Rename "Download as PDF" to "Download report" with singular/plural support.
That PR did two renames, but only documented one of them:
common.downloadAsPDF→ the plural keycommon.downloadReport(Download report / Download reports). The PR did update the help site for this, so nothing is left to do here.common.downloadReceipts→ the plural keycommon.downloadReceipt(Download receipt / Download receipts). The PR did not update the help site for this, so every article still names only the plural Download receipts. That is now wrong whenever the download includes exactly one receipt, which is a common case.The label is driven by a count at each call site, so the singular really does appear in the UI:
This PR names both forms wherever the action is referenced, and states the rule that decides which one you see. It also spells out the "counts receipts, not reports" nuance on the Reports page, because a member selecting two reports that hold one receipt between them will see the singular Download receipt and would otherwise think the option was wrong.
Files changed:
docs/articles/new-expensify/reports-and-expenses/How-to-Export-Reports.md— both receipt-download step lists, both notes, the refresh-behavior list, the "why don't I see it" FAQ, and the no-downloadable-receipts FAQ. Adds one FAQ explaining the singular/plural rule.docs/articles/new-expensify/reports-and-expenses/How-to-Export-Expenses.md— the receipt-download step list, its note, and the "why don't I see it" FAQ. Adds the same singular/plural FAQ.Expense-and-Report-Actions.mdis untouched: it already reads Download report after #101181, and it has no receipt-download row to correct.Labels were checked against
src/languages/en.tsonmain(downloadReport,downloadReceipt) and the Download report label plus the More and Selected entry points were confirmed in the running web app. Both new FAQ headings start with a question word and sit under# FAQ, perdocs/HELP_AUTHORING_GUIDELINES.md; all labels are bolded, in Sentence case, and unquoted, perdocs/HELPSITE_NAMING_CONVENTIONS.md.Fixed Issues
$ #101055
PROPOSAL:
Tests
// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.
Offline tests
Not applicable — this PR only changes help site markdown under
docs/articles.QA Steps
// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.
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
@ahmdshrif, please review the files changed and confirm they reflect the current behavior. Then post a new comment saying
@MelvinBot mark this PR as ready for review.