[update] grammar and style in Calendar articles - #140
Open
serhiipylypchuk1991 wants to merge 9 commits into
Open
[update] grammar and style in Calendar articles#140serhiipylypchuk1991 wants to merge 9 commits into
serhiipylypchuk1991 wants to merge 9 commits into
Conversation
- configuring: 13 API values moved from bold/italic to backticks, six
"by default" openers, three "there is a possibility to" constructions,
eight passive clauses and three "via" replaced
- customization: fixed the "calender" typo, `<style>` in backticks,
list items capitalized, number agreement in "a new CSS class(es)"
- datepicker: fixed number agreement, three missing articles and two
wrong prepositions ("attach into", "on click in"); class names in
backticks where they refer to code identifiers
- headings left untouched: features.md links to their anchors
reviewed with the article-grammar skill; each page re-run after editing,
which caught four defects introduced by the edits themselves
- fixed a missing infinitive: "Learn how initialize Calendar" - fixed prepositions and articles: "a timepicker into Calendar", "use DHTMLX Optimus framework", "creating DHTMLX-based app" - "perform the code after the component's rendering" -> "run code after the component renders" - removed four section intros that only restated their own heading - replaced five "X of Y" constructions with noun phrases and dropped the padded "necessary" in two table cells - re-run after editing caught two more: "for + gerund" in two cells and an inconsistent article in "call the Calendar events"
- section headings switched to the imperative form - API method names wrapped in code formatting instead of bold - passive constructions rewritten in active voice
- passive constructions and gerund chains rewritten in active voice - file names and the container id wrapped in code formatting - "X of Y" phrases replaced with noun phrases or active clauses - missing article added to the "Select an initial date" heading, its in-page anchor and the link to it updated together - duplicate intro sentence dropped from "Initialize Calendar"
- missing article added in "create a calendar" - mode list made parallel: "or as a timepicker" -> "or timepicker" - marketing sentence about a "great date picker solution" dropped - duplicate link to online samples removed from the intro, the one under Related resources kept - comma added after the introductory phrase in the Suite download item - "add Calendar on the page" -> "add Calendar to a page"
- typo fixed: "your need to" -> "you need to" - list intro made a complete sentence, both items capitalized - dhx.i18n.setLocale() moved from bold to code formatting - "days of a week" -> "days of the week" - dhtmlxCalendar renamed to Calendar to match the rest of the page - filler "just" and the non-idiomatic "a ready locale" dropped
- API names, types and string values moved from bold/italic to code formatting (13 occurrences) - mode values in the getCurrentMode() list aligned with the quoted form used in the showDate() list - "allows selecting" -> "allows you to select" in all three modes - commas added after leading dependent clauses - missing articles restored: "the selected date", "the date format" - "via", "and/or" and "a certain mode" replaced with direct wording - passive and future rewritten in active present: attaching to an input, linking two calendars, the setValue() return value - "There is a possibility to get" and "Please note that" dropped Section headings left as they are: renaming them would change the anchors, and 7 links across features.md, customization.md and the whatsnew.md release-notes archive point at them.
- three method names moved from bold to backticks, module name too - section headings changed from gerunds to verb phrases: "Attaching event listeners" -> "Attach event listeners" (no anchors link here, verified across the docs tree) - removed passive voice and future tense from both prose sentences - "the names of events" -> "event names", "the list of events" -> "event list" - re-run after editing flagged the three identical "Use the ... method" openers the first pass had introduced; two now lead with the result
- "Calendar executes all of them" -> "all handlers": the pronoun referred across a sentence boundary after the earlier passive split - "## Call events" -> "## Trigger events": the heading contradicted its own body text, which says "trigger an event manually" the H1 stays a noun phrase on purpose: every page in the section keeps H1 identical to sidebar_label, with title derived from it
serhiipylypchuk1991
changed the title
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.
<style>in backticks, list items capitalized, number agreement in "a new CSS class(es)"reviewed with the article-grammar skill; each page re-run after editing, which caught four defects introduced by the edits themselves