Define acronym in webpage to improve accessibility #3806

dakotatokad · 2024-11-08T18:13:26Z

This PR solves the confusion I had using the new experimental monthly budget comparison report. It simply defines the "MTD" acronym for non-finance savvy people to make understanding the report faster, easier, and more accessible.

I'm still learning React JS and this project is way more complicated that I can understand so this PR is front-end documentation only.

netlify · 2024-11-08T18:13:41Z

✅ Deploy Preview for actualbudget ready!

Name	Link
🔨 Latest commit	`000865e`
🔍 Latest deploy log	https://app.netlify.com/sites/actualbudget/deploys/672e5b5fe2e5c5000850728b
😎 Deploy Preview	https://deploy-preview-3806.demo.actualbudget.org
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2024-11-08T18:14:42Z

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
10	5.34 MB → 5.34 MB (+66 B)	+0.00%

Changeset

File	Δ	Size
`src/components/reports/reports/Spending.tsx`	📈 +66 B (+0.32%)	20.05 kB → 20.11 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

Asset	File Size	% Changed
static/js/ReportRouter.js	1.5 MB → 1.5 MB (+66 B)	+0.00%

Smaller

No assets were smaller

Unchanged

Asset	File Size	% Changed
static/js/workbox-window.prod.es5.js	5.69 kB	0%
static/js/indexeddb-main-thread-worker-e59fee74.js	13.5 kB	0%
static/js/BackgroundImage.js	122.29 kB	0%
static/js/AppliedFilters.js	21.3 kB	0%
static/js/usePreviewTransactions.js	1.64 kB	0%
static/js/resize-observer.js	18.37 kB	0%
static/js/narrow.js	82.57 kB	0%
static/js/wide.js	239.81 kB	0%
static/js/index.js	3.35 MB	0%

github-actions · 2024-11-08T18:14:43Z

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
1	1.27 MB	0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	File Size	% Changed
kcab.worker.js	1.27 MB	0%

coderabbitai · 2024-11-08T18:31:33Z

Warning

Rate limit exceeded

@dakotatokad has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between c570846 and 000865e.

Walkthrough

The pull request introduces modifications to the Spending.tsx component within the desktop client. Key changes include an updated text label for clarity, changing "Spent Average MTD" to "Spent Average Month to Date (MTD)." The logic for rendering comparison data has been refined to ensure accurate display of average spending and budgeted amounts, with added checks for data existence to prevent null reference errors. The useEffect hook remains in place to fetch the earliest transaction data, with adjustments made to ensure that month selections include at least a year's worth of months. The control flow and structure of the component remain largely unchanged, retaining the use of hooks for state management and memoization of graph data via useMemo. The integration of translation functionality through useTranslation is also preserved, ensuring adaptability for different languages. Additionally, method signatures for onSaveWidget and onSaveWidgetName have been updated without changes to their parameters or return types.

Possibly related PRs

SpendingReport: Fixing some display issues #3451: Enhances logic for displaying comparison data in the Spending.tsx component and introduces new visual elements.
✨ (dashboards) ability to quick-edit widget names from inner report pages #3587: Introduces an editable title feature in the Spending.tsx component, related to updates in method signatures for saving widget names.
Fix issue with Monthly Spending report not properly averaging previous three months #3723: Relates to handling of spending data, relevant to the updates in rendering and logic of spending reports in Spending.tsx.

Suggested reviewers

youngcw
carkom

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

…rning

dakotatokad · 2024-11-08T18:43:57Z

Im messing something up, i'm going to take a step back and try again later.

kcollett · 2025-01-18T11:32:26Z

It's unfortunate this attempt to address the problem didn't work out. (I found this PR trying to figure out what the heck "Budgeted MTD" meant.)

dakotatokad · 2025-01-18T15:22:17Z

If you think this is useful, I suggest opening an issue for it. I think it would be a great addition, but I’m not the best person to implement it.

BTW, its "Month to Date" if you hadn't figured it out 😄

kcollett · 2025-01-20T13:48:02Z

OK. See issue #4203.

docs: define mtd acronym to improve accessibility

4921455

actual-github-bot bot added the 🚧 WIP label Nov 8, 2024

docs: add release notes

c570846

dakotatokad marked this pull request as ready for review November 8, 2024 18:27

actual-github-bot bot changed the title ~~[WIP] Define acronym in webpage to improve accessibility~~ Define acronym in webpage to improve accessibility Nov 8, 2024

actual-github-bot bot added 🔍 Ready for review and removed 🚧 WIP labels Nov 8, 2024

dakotatokad added 2 commits November 8, 2024 11:38

docs: change how docs are formatted to circumvent prettier linting wa…

29579e7

…rning

docs: fix line length to <80 char

000865e

dakotatokad closed this Nov 8, 2024

actual-github-bot bot removed the 🔍 Ready for review label Nov 8, 2024

kcollett mentioned this pull request Jan 20, 2025

[Feature] In the Spending Trend report, change "Spent Average MTD" to "Spent Average Month to Date (MTD)." #4203

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define acronym in webpage to improve accessibility #3806

Define acronym in webpage to improve accessibility #3806

dakotatokad commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

coderabbitai bot commented Nov 8, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

dakotatokad commented Nov 8, 2024

kcollett commented Jan 18, 2025

dakotatokad commented Jan 18, 2025 •

edited

Loading

kcollett commented Jan 20, 2025

Define acronym in webpage to improve accessibility #3806

Define acronym in webpage to improve accessibility #3806

Conversation

dakotatokad commented Nov 8, 2024 • edited Loading

netlify bot commented Nov 8, 2024 • edited Loading

✅ Deploy Preview for actualbudget ready!

github-actions bot commented Nov 8, 2024 • edited Loading

Bundle Stats — desktop-client

github-actions bot commented Nov 8, 2024 • edited Loading

Bundle Stats — loot-core

coderabbitai bot commented Nov 8, 2024 • edited Loading

Rate limit exceeded

Walkthrough

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

dakotatokad commented Nov 8, 2024

kcollett commented Jan 18, 2025

dakotatokad commented Jan 18, 2025 • edited Loading

kcollett commented Jan 20, 2025

dakotatokad commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 8, 2024 •

edited

Loading

coderabbitai bot commented Nov 8, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

dakotatokad commented Jan 18, 2025 •

edited

Loading