Skip to content

docs: Refine documentation for clarity and consistency#2038

Open
AminMemariani wants to merge 10 commits intoimaNNeo:mainfrom
AminMemariani:main
Open

docs: Refine documentation for clarity and consistency#2038
AminMemariani wants to merge 10 commits intoimaNNeo:mainfrom
AminMemariani:main

Conversation

@AminMemariani
Copy link
Contributor

  • Improved grammar and clarity in CONTRIBUTING.md, README.md, and various documentation files.
  • Standardized phrasing for properties in chart data classes across documentation.
  • Enhanced descriptions for touch handling and tooltip functionalities in scatter, pie, and radar charts.
  • Corrected minor typographical errors and formatting issues throughout the documentation.

@imaNNeo
Copy link
Owner

imaNNeo commented Dec 20, 2025

Thank you, it looks good to me.
But now there are some conflicts. (Maybe because of your changes in other branches).

So please update your branch, then we can merge it!

@codecov
Copy link

codecov bot commented Dec 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.00%. Comparing base (9f74754) to head (6042278).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2038   +/-   ##
=======================================
  Coverage   93.00%   93.00%           
=======================================
  Files          50       50           
  Lines        3917     3917           
=======================================
  Hits         3643     3643           
  Misses        274      274           
Flag Coverage Δ
flutter 93.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AminMemariani
Copy link
Contributor Author

Thank you, it looks good to me. But now there are some conflicts. (Maybe because of your changes in other branches).

So please update your branch, then we can merge it!

You are welcome. Although the branch was updated, there were pipeline constraints that were blocking my commits, so I had to fix them.

@imaNNeo
Copy link
Owner

imaNNeo commented Feb 25, 2026

Oh sorry, I made some changes in #2057
So it seems there are some conflicts now.

- Improved grammar and clarity in CONTRIBUTING.md, README.md, and various documentation files.
- Standardized phrasing for properties in chart data classes across documentation.
- Enhanced descriptions for touch handling and tooltip functionalities in scatter, pie, and radar charts.
- Corrected minor typographical errors and formatting issues throughout the documentation.
- Add pump() calls between gesture movements for better timing
- Add extra pump() calls after scaling to ensure chartVirtualRect is updated
- Add null checks before assertions to make tests more robust
- These changes should help tests pass reliably in CI environments
- Replace tester.dragFrom() with startGesture/moveTo/up pattern
- This approach works better with CustomInteractiveViewer's GestureDetector
- Add null checks after panning to ensure chartVirtualRect is updated
- Should fix CI test failures for panning tests
- Verify that scaling actually occurred before attempting to pan
- Wait for chartVirtualRect to be updated with proper size
- Add attempt counter to prevent infinite loops in CI
- This ensures tests wait for scaling to complete before panning
- Add unique key to ColoredBox widgets used in panning tests
- Replace find.byType(ColoredBox) with find.byKey(chartColoredBoxKey)
- Fixes CI error: 'Found 2 widgets with type ColoredBox' ambiguity
- Ensures tests can uniquely identify the chart widget
@AminMemariani AminMemariani changed the title Refine documentation for clarity and consistency docs: Refine documentation for clarity and consistency Mar 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants