[fix] correct typo and wrong words in List guides - #156
Open
serhiipylypchuk1991 wants to merge 6 commits into
Open
serhiipylypchuk1991 wants to merge 6 commits into
serhiipylypchuk1991 wants to merge 6 commits into
Conversation
Wrong, not merely clumsy: - "the possiblity of dragging" was misspelled. 1 such misspelling remains in the docs, in 1 file - "It presupposes that data is rendered by parts" and "Setting the multiselection property to true presupposes selection of multiple items" both used presupposes for "means". The first also said by parts where it meant in parts, the only such phrase in the docs - "as easy as that" would need to be as easily; the phrase is dropped rather than corrected, since it adds nothing Names and literals: - itemHeight and multiselection were bold in running prose and now use code formatting, as the api formatting rule requires - true, false and ctrlClick moved from italics and quotes to code - the drag mode values target, source and both moved from quotes to code, the dominant form for a value list: 229 against 39 Wording: - "provides the possibility to navigate" became "lets you navigate" - "All data is loaded into List and rendered at once" became "List loads and renders all data at once" - "There is a possibility to increase the speed of your application containing a List" became "You can increase the speed of an application that contains a List", the modifier having attached to the wrong noun - "allows highlighting a List item" became "allows you to highlight", the form the gerunds rule prescribes - "In case you use" and "In case you need" became If - "Set as its value a function" became "Set its value to a function" - "of a custom template of List items" became "of a custom List item template" - two sentences lost a repeated word: selection twice in one clause, and "enable the possibility to select" - added a colon before a code block, removed three trailing spaces - the two brace notes became the triple-colon form. This is NOT a rendering fix, the macro expands correctly; it follows the dominant syntax, now 467 triple-colon against 133 brace blocks Measured and left alone: make use of (60 hits in 38 files), the italic type names, since function is italic 42 times and never in code format, and the italic CSS calc() function phrase, 7 uses against 0 for a code-formatted calc(). The hyphen separating a value from its description is also the house form and stays. No heading was touched: 32 links point here and nearly every heading carries an anchor. Left for the author: this page and list_itemheight_config.md both give a default item height of 37 with no unit. Verified with a docusaurus build, and the rendered page was checked to confirm both notes became admonitions and every literal became code.
- "You can style particular cells in the list" said cells, a thing List does not have. The word appears 0 times in all of docs/list, and the heading directly above the sentence reads Styling items, while the next paragraph says each even item. Now items - "add a new CSS class(es)" did not agree in number; it now reads "a new CSS class (or classes)", matching the parenthetical of the next bullet - "make changes in the look and feel of a list. For this you need to take the following steps" became "You can change the look and feel of a list. To do this, take the following steps": changes in takes to, the opener was padding, and the introductory phrase needed its comma - "customize selection of an item" was missing an article The Styling section is a template shared by twenty component pages, so only its outright errors were touched. Left as they are, being clumsy rather than wrong: "your file with styles" (20 uses), "include your file on the page", and "the name of the created CSS class". The escaped style element also stays: 20 pages write it that way against 1 that puts it in code format. After this commit the template still carries 19 copies of the class(es) mismatch in 19 files, 19 of "make changes in the look and feel", and 33 of "There is a possibility to" across 30 files. That last construction sits above the threshold at which house forms are normally left alone; it is corrected here because the same construction was corrected in the previous commit, and being consistent inside one branch matters more than the threshold. Same defect elsewhere, not touched: dataview/customization.md says "style particular cells in the dataview", and cell appears 0 times in docs/dataview against 192 for item. CSS classes on this page were checked and are sound: every class the samples define is used and every class used is defined, with no look-alike characters. That is the defect found earlier in the Grid and Layout customization pages; it is not present here. Verified with a docusaurus build, and the rendered page carries no occurrence of the word cell.
Wrong, not merely clumsy: - "go into deep dive on its functionality" is not an idiom; it is now "dive deep into its functionality". 19 copies remain in 19 files - "perform the code" became "run the code": code is run. 19 copies remain in 19 files - "you can find out corresponding references of List API" became "you can find the corresponding List API references". References are found, not found out, and the article was missing. 19 copies remain - "use DHTMLX Optimus framework for creating DHTMLX-based app" was missing both articles, and carried a stray double space. 19 copies remain in 19 files - "on the initialization stage" became "at the initialization stage". 17 copies remain - "from external file" and "from external DataCollection" each gained the missing article; 4 and 3 copies remain - "for working with data of List, i.e. edit, add, remove, sort data, etc." became "to work with List data, such as editing, adding, removing and sorting it". The abbreviation introduced examples while meaning "that is", and with such as the trailing etc. was redundant. The docs still hold 19 uses of the first and 39 of the second - "from a selected item(s)" does not agree; it now reads "from a selected item (or items)", the same shape used for class(es) in the customization page. 1 copies remain Deliberately left, being weaker phrasing rather than error: - the seven ways this page and its siblings open a section. There is no majority to align to: you can find out 45, you will learn 32, you can learn 25, this section explains 19, you may study 15, will tell you 8, you will know 7. The Layout features page was left the same way; the Grid one was harmonised, but only because a single file there contradicted itself, which is not the case here - restrictive which in "functionality of the library which can be useful", 20 copies, since the form is grammatical - "help you to start working", and the double spaces inside table cells, which do not reach the rendered page No heading was touched, no link target changed, and the curly apostrophe in "component's rendering" was preserved rather than flattened to ASCII. Verified with a docusaurus build.
- "arrange multiple objects ... and make your data organized" became "and keep your data organized". The phrase was the only one of its kind in the docs, so nothing else shares it - "To work with data of List check the DataCollection API" became "To work with List data, check ...": the introductory clause needed its comma, and the noun chain read backwards. 1 such chain remains elsewhere in the docs - removed the trailing space that ended the opening paragraph Measured and deliberately left, all of them shared templates rather than defects of this page: - "as a part of the Suite library" (19 copies). The tighter "as part of" appears 0 times in the whole documentation, so changing this would invent a form rather than follow one; the longer phrase is used 46 times across 39 files and is grammatical - "by downloading DHTMLX Suite" (17 copies in 17 files) - "There are also online samples ..." (21 copies) and "You can check the following page ..." (21 copies) Worth a separate look, not touched here: the page links to the same samples URL twice with the same label, once in the opening paragraph and once under Related resources. That duplication comes from the shared template, so it belongs to all 21 pages rather than this one. No heading was touched, no link target changed, and the nine empty-label links that the build expands are intact. Verified with a docusaurus build, and the rendered page was checked to confirm both rewrites landed and the kept forms stayed.
Wrong, not merely clumsy: - "You can manipulate with List items" lost the preposition: manipulate is transitive. Master carries 4 of these; this commit fixes one, leaving 3 in 3 files - "the method selects all unselected items when calling without parameters" became "when called". As written, the participle makes the method do the calling. Master carries 7; two of them were on this page, leaving 5 in 4 files Worth stating, since it cuts against how other phrases in this series were handled: before this change the correct wording appeared 0 times in the whole documentation, and the 2 occurrences that exist now are the two introduced here. A missing precedent stopped me from touching "as part of" and a code-formatted calc(), but those existing forms were grammatical and merely less idiomatic. This one is not, so the absence of a precedent only means every copy shares the error Formatting and house forms: - the five bold API names on the page moved to code formatting. Master already writes 466 of these in code against 154 in bold, so this follows the established form rather than anything introduced by this series - "As a parameter the method takes the id of an item" became "The method takes as a parameter the id of an item". Master holds 3 of the inversion against 33 of the form now used, in 27 files - the brace note became the triple-colon form. Master holds 127; 124 remain in 92 files. This is not a rendering fix, the macro expands correctly - removed a trailing space from the prose. The one inside the code sample was left alone, being out of scope Measured and deliberately left, being weaker phrasing rather than error: "make use of" (60 copies in 38 files), "To make the process of working with the selection of items more flexible" (7 copies), and the split between "the Selection object" (24) and "the selection object" (11), which is a naming convention for the maintainer to settle rather than a grammar point. No heading was touched: features.md and work_with_list.md link to three of them by anchor. Verified with a docusaurus build, and the rendered page was checked to confirm both errors are gone and no bold API name survives.
Each count below is given as master, then what remains after this change, so neither figure goes stale because of the edit itself. - "It will return the id of an item in focus" became "It returns". A method's behaviour belongs in the present, and the sentence two paragraphs above already says "It takes". Master holds 6, leaving 5 in 4 files - "an object with new configuration of the item" was missing its article. Master holds 3, leaving 2 - "Pass the id of the item that should be removed to the method" stranded "to the method" at the end, so the sentence briefly reads as an item being removed to the method. It now says "Pass to the method the id of the item that should be removed". Master holds 3, leaving 2 Measured and deliberately left: - DataCollection on the removeAll line, against Data Collection five times elsewhere on the page. This looks like an internal contradiction, and I was going to align it, but the documentation writes DataCollection 261 times across 88 files against 51 for the spaced form in 15. The page as a whole is the minority, not that one line, and the joined spelling may well be the class name, which is out of scope to touch - the page says "It takes the id of an item as a parameter" in one place and "It takes as a parameter the id of an item" in another. Both are ordinary English; the docs use the trailing form 28 times against 13 for the other, and imposing one for the sake of a single page would be taste rather than correction - "make use of" (60 copies in 38 files) and "with the help of" (133 in 81), both house forms No heading was touched: twelve links point at this page and eight of its headings carry anchors, including from features.md and whatsnew.md. Verified with a docusaurus build, and the rendered page was checked to confirm all three rewrites landed and both HTML tables still render.
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.
Wrong, not merely clumsy:
Names and literals:
Wording:
Measured and left alone: make use of (60 hits in 38 files), the italic type names, since function is italic 42 times and never in code format, and the italic CSS calc() function phrase, 7 uses against 0 for a code-formatted calc(). The hyphen separating a value from its description is also the house form and stays.
No heading was touched: 32 links point here and nearly every heading carries an anchor.
Left for the author: this page and list_itemheight_config.md both give a default item height of 37 with no unit.
Verified with a docusaurus build, and the rendered page was checked to confirm both notes became admonitions and every literal became code.