[update] grammar and API formatting in docs guides#77
Open
serhiipylypchuk1991 wants to merge 7 commits into
Open
[update] grammar and API formatting in docs guides#77serhiipylypchuk1991 wants to merge 7 commits into
serhiipylypchuk1991 wants to merge 7 commits into
Conversation
Grammar and writing-style review (article-grammar) of the first batch of top-level docs articles: - angular_integration, awaitredraw, configuration, customization, data_formatting - fix wordiness, tense, articles, passive voice and redundant phrasing - wrap API names (methods, properties, params, types, classes) in backticks; replace bold/italic API names with backticks - format file names and paths as italic - unify readonly -> read-only wording
Grammar and writing-style review (article-grammar) of the second batch of top-level docs articles: - excel_import_export, filtering_data, functions - remove passive voice, wordiness and redundant phrasing - fix tense, articles and 'may' -> 'can' in filtering guide - data_search and formulas_locale needed no changes
Grammar and writing-style review (article-grammar) of the third batch of top-level docs articles: - guides, handling_events, how_to_start, index - fix typo 'guide your' -> 'guide you', tense, articles and passive/wordy phrasing; tone down puffery - correct context menu item count (5 -> 6) in overview - wrap API names in backticks (parse, toolbarBlocks, event methods); format index.html as italic; unify readonly -> read-only - hotkeys needed no changes
Grammar and writing-style review (article-grammar) of the fourth batch of top-level docs articles: - initialization, loading_data, localization, merge_cells, migration - replace passive voice, future tense and wordy phrasing with active present-tense wording; tone down puffery - wrap API names in backticks (css, locked, link, value, text, toolbarBlocks, event methods); format worker.js/folders as italic; unify .xlsx in backticks; 'Please note that' -> 'Note that'
Grammar and writing-style review (article-grammar) of the fifth batch of top-level docs articles: - number_formatting, number_formatting_guide, sorting_data, svelte_integration, using_typescript - fix passive voice, future tense, wordiness and 'how ... looks like' - fix typos: 'ommitted' -> 'omitted', 'Typescript' -> 'TypeScript', and a wrong code comment (currency -> percent example) - wrap property/param names and value literals in backticks; format Svelte file names as italic; switch first person to second person
Grammar and writing-style review (article-grammar) of the sixth batch of top-level docs articles: - vuejs_integration, work_with_cells, work_with_rows_cols, work_with_sheets - fix passive/future tense, wordiness and awkward 'the appeared ...' and 'go one of the ways' phrasing - wrap formula examples in backticks; format Vue file names as italic - whats_new needed no changes (changelog prose is clean)
Grammar and writing-style review (article-grammar) of the seventh batch of top-level docs articles: - working_with_cells, working_with_sheets, working_with_ssheet - replace passive voice, future tense and existential 'there is' with active present-tense wording; drop wordiness - wrap method names in link labels and value literals in backticks - fix typo 'withing' -> 'within'
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.
Grammar and writing-style review (article-grammar) of the first batch of top-level docs articles: