[update] grammar and style in Chart user guides - #143
Open
serhiipylypchuk1991 wants to merge 9 commits into
Open
[update] grammar and style in Chart user guides#143serhiipylypchuk1991 wants to merge 9 commits into
serhiipylypchuk1991 wants to merge 9 commits into
Conversation
serhiipylypchuk1991
commented
Sep 7, 2026
serhiipylypchuk1991
commented
Contributor
- fixed the chart count: the intro claimed 11 types while the article itself lists 13, matching chart_type_config.md (treeMap since v7.3, calendarHeatMap since v8.0)
- fixed a typo ("represent you data"), "charts types", and two comma splices in the intro and the Bar section
- "less than 10 items" -> "fewer": items are countable
- hyphenated "two dimensional", already spelled correctly one screen above in the Radar section
- rewrote all eight type descriptions: removed future tense, four passive clauses, "in order to", "The peculiarity of X is that", four missing articles and the "represent" verb
- dropped the table-of-contents entry that repeated the page title
- fixed the chart count: the intro claimed 11 types while the article
itself lists 13, matching chart_type_config.md (treeMap since v7.3,
calendarHeatMap since v8.0)
- fixed a typo ("represent you data"), "charts types", and two comma
splices in the intro and the Bar section
- "less than 10 items" -> "fewer": items are countable
- hyphenated "two dimensional", already spelled correctly one screen
above in the Radar section
- rewrote all eight type descriptions: removed future tense, four
passive clauses, "in order to", "The peculiarity of X is that",
four missing articles and the "represent" verb
- dropped the table-of-contents entry that repeated the page title
- fixed "the chart will displayed" in two sections: the auxiliary verb was missing - fixed a broken code sample: the string literal in the Area/SplineArea example was split across two lines, so the snippet did not parse - "inclusively" -> "inclusive" in six range descriptions - startDate and endDate moved from bold to backticks, matching how the Mixed graphs section already writes API names; value types in the Main properties list moved from italics to backticks as well - "actual for all chart types" -> "that apply to", "individual for particular types" -> "specific to", "the minimal/maximal year" -> "earliest/latest" - replaced eight future-tense passives in the date-range examples, "i.e." twice, "via", and a semicolon that introduced a value list - corrected the maxPoints description: the property sets a threshold, it does not display anything - restored missing spaces and the serial comma in the scale type list
- five option names moved from bold to backticks: textTemplate, gradient, tooltipTemplate, showTextTemplate, valueTemplate - `<style>` written as a code span instead of an escaped HTML entity - replaced three noun phrases that hid their verb: "there is a possibility to", "it is possible to define", "you can easily define" - dropped "with the help of" and "via", added the missing article in "in tooltip" and the serial comma in "Pie, Pie3D, and Donut" - list items in the styling steps now start with a capital letter - headings left as they are: whatsnew.md links to the anchor of the last one, so renaming five of six would break consistency
- fixed "A data set for Treemap chart has also another structure": wrong adverb placement and a missing article, same omission for the Calendar heatmap chart one section below - serialize() moved from bold to backticks, matching load() and parse() on the same page; key:value and "color": "value" set as code - fixed three wrong prepositions: "on the initialization stage", "wrap into a promise", "parse the data to a different chart" - replaced three future-tense forms describing constant behaviour - "make use of" -> "use", "the URL of the file with data" -> "the data file URL", dropped "Please note that" inside an info block - "Heatmap chart" -> "Calendar heatmap chart", added the serial comma in "Pie, Pie3D, and Donut", capitalized four list items
- fixed two code samples that did not parse: function({width:500,
height:500}) is an invalid destructuring target, node --check failed
on both blocks; now function({ width, height })
- three method names moved from bold to backticks
- section headings changed from gerunds to verb phrases; no file links
to these anchors, verified across the docs tree
- "Calling events" -> "Trigger events": you call a method, an event is
triggered
- "The full list of events is available in the related API section" ->
"For the full event list, see the API section"
- section openers deliberately varied instead of unified: on the
Calendar page the same fix produced three identical "Use the ...
method" lines, which the next review flagged as repetition
- H1 left as a noun phrase: every page in the section keeps H1 equal to
sidebar_label, and features.md links here under the same label
- closed an unclosed parenthesis: "(for x,y, or both scales" - "you will know how to export" -> "learn how to": know is a state, not something a section teaches - "go into deep dive on its functionality" -> the intro now says what the page actually is, a directory of guides and references - "perform the code" -> "run code", "perform iteration" -> "iterate" - removed six section intros that only restated their own heading and unwrapped four more from the "In this section you can..." frame - fixed missing articles before Bar chart twice, before charts with scales, and in the Optimus cell; dropped the extra article in "call the Chart events", which lines below write without it - "Check the list of all available DataCollection API" trailed off; now "Check the full DataCollection API reference" - kept the repeated "Learn how to" in table cells on purpose: in a navigation table the identical opening is what makes the column scannable
- fixed a broken parallel in the intro: "the possibility to render ... and adding tooltips" mixed an infinitive with a gerund inside a 47-word sentence, now split in two - "add Chart on the page" -> "to a page" - added the comma after introductory phrases in two Related resources items, where the first item already had it, and terminal periods to all four - DataCollection wrapped in backticks - replaced marketing wording: "a great tool", "powerful charts", "a whole kit of", "full-featured" - dropped the duplicate link to online samples: the same URL appeared in the intro and in Related resources - "our website" -> "the DHTMLX website": the rest of the docs is written impersonally
- four file names moved from italics to backticks, matching how the Calendar initialization page already writes the same list - container id and the HTML id attribute set as code - fixed three prepositions: paths go in a header not into it, "at the previous step" -> "in", and the stranded "a container to place a Chart into" - "as a part of the Suite package" -> "as part of", in both the info block and the section below - "Detailed information ... is given in the article" -> the article itself is now the subject - "a folder of your project" -> "your project folder", dropped "you need to take the following steps" and "you need to include" twice - list items under the constructor now start with a capital letter and the link label says what it points to instead of "here"
- fixed a sentence that contradicted its own code sample: the text told the reader to pass an array of series objects to the handler, while eachSeries calls the handler once per series - property names in the HTML table and the series id set as code; Export module wrapped in backticks in two places where the line above already did it - "add items into your Chart" -> "to your Chart"; the heading keeps "into" because features.md links to its anchor - replaced four noun phrases hiding their verb: "gives you the possibility to get", "It is possible to iterate", "with the help of", "takes as a parameter an object with..." - "perform iteration" -> "iterate", "perform operations with" -> "work with", "via the corresponding methods" -> the two methods by name - "A new data item is added" -> Chart is now the subject; "in case of adding many items" -> "when you add several items"
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.