Skip to content

[update] grammar and style in Colorpicker guides - #144

Open
serhiipylypchuk1991 wants to merge 8 commits into
nextfrom
sp-next-colorpicker-article-grammar
Open

[update] grammar and style in Colorpicker guides#144
serhiipylypchuk1991 wants to merge 8 commits into
nextfrom
sp-next-colorpicker-article-grammar

Conversation

@serhiipylypchuk1991

Copy link
Copy Markdown
Contributor
  • replace "It is possible to"/"There is a possibility to" openers with active phrasing
  • rewrite passive constructions so Colorpicker or the reader is the subject
  • put code values and property names in backticks instead of italic/bold
  • drop vague "via" and "with the help of" in favour of direct verbs
  • fix the missing article in "at the top of the palette"
  • call paletteOnly a configuration option, not a mode
  • unify the transparency link with the other auto-labeled API links

- replace "It is possible to"/"There is a possibility to" openers with active phrasing
- rewrite passive constructions so Colorpicker or the reader is the subject
- put code values and property names in backticks instead of italic/bold
- drop vague "via" and "with the help of" in favour of direct verbs
- fix the missing article in "at the top of the palette"
- call paletteOnly a configuration option, not a mode
- unify the transparency link with the other auto-labeled API links
@serhiipylypchuk1991 serhiipylypchuk1991 self-assigned this Sep 8, 2026
- replace the "There is a possibility to" opener with active phrasing
- capitalize list items and add the missing colon before the code block
- fix "a new CSS class(es)" article and number mismatch
- put the style tag in backticks and drop the plain-text css link label
- trim wordy asides: desired settings, your file with styles, don't forget
- rewrite section intros in present simple instead of "In this section you will find out"
- add the missing articles in Optimus, palette, API and library descriptions
- replace "mode of displaying Colorpicker" with "Colorpicker display mode"
- fix "perform the code" and the focus row that promised a value instead of a color
- drop vague "certain color", "necessary width" and "and more"
- remove the stray leading space before the palette heading
- put the events.on/detach/fire method names in backticks instead of bold
- open all three sections with the same "You can ... with the ... method" form
- say "detach event listeners" instead of "detach events"
- let the API section link carry the sentence instead of "is available in the related"
- fix "a colorpicker and a popup objects" and the missing articles around it
- replace "presupposes" and "attach a colorpicker into it" with plain wording
- spell the component as Colorpicker everywhere instead of ColorPicker/color picker
- put suite.js, suite.css and null in backticks instead of italic
- capitalize the parameter and popup step lists, add the missing comma
- rewrite passive constructions and turn the broken "and initialize..." line into a sentence
- align the contents link label with the "Select initial color" heading
- split the 36-word intro sentence and attach "can be used" to the component, not to colors
- replace "It possesses easy-to-configure interface" with an active sentence and the missing articles
- drop the evaluative "smart", "simply" and "handy"
- give the Guides intro a subject and infinitives instead of a gerund pile
- spell the component as Colorpicker instead of ColorPicker
Applies across all component overview pages the three defects found while
reviewing the Colorpicker overview, so the shared template stays in sync.

- "as a part of the Suite library" -> "as part of" (17 overview pages, plus the
  Grid and Tree initialization sentences)
- "You can get X ... by [downloading DHTMLX Suite]" -> "[Download DHTMLX Suite]
  to get X ...", dropping the "by -ing" link
- "There are also [online samples ...]" -> "Try the [online samples ...]" (21 pages)
- "You can check the following page to learn how to build ..." -> "Learn how to
  build ..." (21 pages)

List items keep their existing no-period style so each list stays consistent.
- replace "make use of the ... method" with "Use the ... method to ..."
- call the "palette"/"picker" states modes, matching the API and the heading
- rewrite passive constructions: is rendered, which is shown, will be displayed
- drop vague "via", "with the help of", "a certain color" and "handy"
- spell the component as Colorpicker instead of ColorPicker/color picker
- move "as a parameter" after the object it follows
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.

1 participant