Fix documentation spelling, grammar, and punctuation errors - #2099
Conversation
…verview docs Co-authored-by: beto-rodriguez <10853349+beto-rodriguez@users.noreply.github.com>
Co-authored-by: beto-rodriguez <10853349+beto-rodriguez@users.noreply.github.com>
Co-authored-by: beto-rodriguez <10853349+beto-rodriguez@users.noreply.github.com>
… docs Co-authored-by: beto-rodriguez <10853349+beto-rodriguez@users.noreply.github.com>
Co-authored-by: beto-rodriguez <10853349+beto-rodriguez@users.noreply.github.com>
Thanks for your contribution! 🤗 (1 / 4)The build and test process is starting. This may take a while. Core Test Results Summary (Failure) ❌ (4 / 4) |
There was a problem hiding this comment.
Pull request overview
This PR polishes documentation across the repo by correcting spelling/grammar/punctuation and adjusting a few example snippets for clarity and correctness.
Changes:
- Fixes numerous typos, duplicated words, and punctuation issues across docs and root markdown files.
- Improves wording/capitalization consistency (e.g., LiveCharts/.NET) and clarifies several explanatory paragraphs.
- Updates some code examples (notably collection mutation and property access) to better reflect valid usage.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/shared/series2.md | Rewords DataPadding description for readability (but currently documents the wrong type). |
| docs/shared/series.md | Improves prose and updates code examples for Values mutation and mapping sample. |
| docs/shared/polarlabels.md | Removes duplicated word in info block. |
| docs/shared/chart.md | Fixes grammar around easing builders and animation disabling statement. |
| docs/samples/lines/xy/template.md | Rewrites intro paragraph for clarity and correct grammar. |
| docs/samples/general/visualElements/template.md | Fixes duplicated phrase and improves punctuation/formatting in layout explanation. |
| docs/samples/general/multiThreading/template.md | Improves punctuation/grammar in concurrency guidance. |
| docs/samples/general/customTooltips/template.md | Fixes missing space after punctuation and improves readability. |
| docs/samples/general/chartToImage/template.md | Clarifies wording (“as long as”) and improves sentence structure (still has inconsistent ASP.NET/.NET Core capitalization). |
| docs/samples/events/tutorial/template.md | Removes duplicated “only” for clearer sentence. |
| docs/samples/axes/matchScale/template.md | Fixes typo (“mater”→“matter”) and improves punctuation. |
| docs/polarchart/overview.md | Changes TotalAngle example value (this alters demonstrated behavior). |
| docs/overview/1.9.animations.md | Improves sentence structure and fixes grammar (“provider”→“provides”). |
| docs/overview/1.5.mappers.md | Fixes wording/grammar and minor capitalization (JSON, let’s). |
| docs/overview/1.12.themes.md | Improves readability and fixes several grammar issues in theme explanation. |
| docs/geomapchart/heatlandseries.md | Improves prose and fixes minor formatting/spacing in sample code. |
| docs/cartesianChart/stackedlineseries.md | Fixes typos and improves punctuation in geometry description. |
| docs/cartesianChart/stackedcolumnseries.md | Fixes “aso”→“also”. |
| docs/cartesianChart/overview.md | Fixes duplicated word (“the the”). |
| docs/cartesianChart/legends.md | Renames/rewrites section to correctly describe custom legends (not tooltips). |
| docs/cartesianChart/columnseries.md | Fixes “aso”→“also”. |
| docs/cartesianChart/boxseries.md | Fixes “aso”→“also”. |
| docs/cartesianChart/axes.md | Fixes duplicated words/typos and improves inclusive language and punctuation. |
| README.md | Improves grammar, punctuation, and product naming consistency. |
| CONTRIBUTING.md | Fixes punctuation/grammar in style guide bullets and examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The data padding is the minimum distance from the edges of the series to the axis limits, it is of type `System.Drawing.PointF` | ||
| both coordinates (X and Y) goes from 0 to 1, where 0 is nothing and 1 is the axis tick an axis tick is the separation between | ||
| The data padding is the minimum distance from the edges of the series to the axis limits. It is of type `System.Drawing.PointF`. |
There was a problem hiding this comment.
DataPadding is documented as System.Drawing.PointF, but in the codebase ISeries.DataPadding is LiveChartsCore.Drawing.LvcPoint. This type mismatch can mislead users; please update the docs to reference LvcPoint (and keep the sample consistent).
| The data padding is the minimum distance from the edges of the series to the axis limits. It is of type `System.Drawing.PointF`. | |
| The data padding is the minimum distance from the edges of the series to the axis limits. It is of type `LiveChartsCore.Drawing.LvcPoint`. |
| var series2 = new {{ name | to_title_case_no_spaces }}<double> | ||
| { | ||
| Values = new ObservableCollection<double> { 2, 1, 3 } | ||
| } | ||
| series2.add(4); // and the chart will animate the change! | ||
| ((ObservableCollection<double>)series2.Values).Add(4); // and the chart will animate the change! |
There was a problem hiding this comment.
The C# snippet declares series2 with an object initializer but does not terminate the statement before calling Add(...) on the next line, so the example as shown won’t compile. Please end the initializer with a semicolon (and ensure the rest of the snippet follows valid C# statement boundaries).
|
|
||
| :::tip | ||
| Notice that the previous code also works in an `ASP.net` project, as far as you are using .NET core 3.1 or greater | ||
| Notice that the previous code also works in an `ASP.net` project, as long as you are using .NET core 3.1 or greater |
There was a problem hiding this comment.
The tip still uses ASP.net / .NET core capitalization. Elsewhere in the docs and in this PR you standardize on .NET; consider updating this line to ASP.NET and .NET Core for consistent product naming.
| Notice that the previous code also works in an `ASP.net` project, as long as you are using .NET core 3.1 or greater | |
| Notice that the previous code also works in an `ASP.NET` project, as long as you are using .NET Core 3.1 or greater |
| ```xml | ||
| <PolarChart | ||
| Series="Series" | ||
| TotalAngle="50"> | ||
| TotalAngle="270"> | ||
| </PolarChart> |
There was a problem hiding this comment.
This changes the TotalAngle example value from 50 to 270, which alters the behavior shown by the documentation. The PR description says changes don’t alter technical content; either revert this to a non-behavioral edit, or update the PR description to acknowledge the functional example change.
Corrected spelling, grammar, and punctuation errors across 29 documentation files. Changes improve readability without altering technical content.
Changes by Category
Spelling corrections:
Grammar fixes:
Capitalization standardization:
Code example corrections:
Files Updated
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.