Skip to content

Fix grammar and wording - #4325

Closed
cobaltt7 wants to merge 10 commits into
ScratchAddons:masterfrom
cobaltt7:grammar
Closed

Fix grammar and wording#4325
cobaltt7 wants to merge 10 commits into
ScratchAddons:masterfrom
cobaltt7:grammar

Conversation

@cobaltt7

@cobaltt7 cobaltt7 commented Feb 24, 2022

Copy link
Copy Markdown
Contributor

also some stuff for consistency and remove opinionated stuff

Signed-off-by: RedGuy12 <paul@reid-family.org>
e
Signed-off-by: RedGuy12 <paul@reid-family.org>
Comment thread README.md
Comment on lines -22 to +28
Scratch Addons is a WebExtension (supports both Chrome and Firefox). Scratch Addons' mission is to combine all existing Scratch extensions, userscripts and userstyles into a single easy-to-access place, while still letting users choose which ones to enable.
Scratch Addons is a WebExtension supporting both Chrome and Firefox. Scratch Addons' mission is to combine all existing Scratch extensions, userscripts, and userstyles into a single easy-to-access place, while still letting users choose which ones to enable.

### What's actually an "addon"?

An addon is similar to an extension or a userscript, but they use special APIs provided by the Scratch Addons extension. These APIs allow addons to run scripts on a Scratch page (userscripts), run scripts on the background (persistent scripts), or apply styles to the Scratch website (userstyles).
An addon is similar to an extension or a userscript, but they use special APIs provided by the Scratch Addons extension. These APIs allow addons to run scripts on a Scratch page (userscripts) or apply styles to the Scratch website (userstyles).

Userscripts and persistent scripts can use the `addon.*` JavaScript APIs, which allow them to obtain Scratch-related information (for example, get the current logged in user) and also use extension APIs (like sending notifications).
Userscripts can use the `addon.*` JavaScript APIs, which allow them to obtain Scratch-related information (for example, get the currently logged-in user) and also use extension APIs (like sending notifications).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to update FAQ

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FAQ has an open pr to make it less techy

@Hans5958 Hans5958 Feb 24, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should move this somewhere. The README is too long with it. The reason I put it on FAQ is so later we can remove it from the README.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's fine imo. there are many readmes that are way longer

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those long README are those that don't have wiki or other types of documentation (see youtube-dl). We have exaustive amount of documentation but we put it on the README. If README can go simpler than I rather.

The README could be also used for advertisement like the website.

Comment thread CODE_OF_CONDUCT.md Outdated
Comment thread _locales/en/messages.json Outdated
Comment thread addons/better-emojis/addon.json Outdated
{
"name": "Better emojis",
"description": "Replaces the emojis in comments on the website with improved vector designs.",
"name": "Vectorized emojis",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should not be changed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Better" is very opinionated.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Vectorize" is not a word people use often.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vector emojis?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HQ/HD emojis

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Vector" is too technical. "HD emojis" or "High quality emojis" sound better.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"High quality" would suggest that the design of the emojis isn't changed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so what do i do? for this and for material-forum-editor-buttons

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think something like "Alternative emoji design" could be used for this one (and "alternative icons in forum post editor" for material-editor-buttons).

Comment thread addons/better-emojis/addon.json Outdated
{
"name": "Grab single block with Ctrl key",
"description": "Adds the ability to drag a single block out of the middle of a script (instead of the entire stack attached below it) while holding the Ctrl key.",
"name": "Single block grab",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"grabbing"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but then its a verb

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Single block grabbing is a noun phrase?

Comment thread addons/block-duplicate/addon.json Outdated
"name": "Enhanced full screen",
"description": "Fixes some undesired effects in the project player's full screen mode, opens it in your browser's full screen mode, and hides the green flag toolbar.",
"name": "Browse-native full screen",
"description": "Fixes some undesired effects in the project player's full screen mode, opens it in your browser's full screen mode, and/or hides the green flag toolbar.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use and/or

Comment thread addons/fullscreen/addon.json Outdated
{
"name": "ocular integration",
"description": "Shows ocular statuses and forum post reactions. Uses my-ocular.jeffalo.net to obtain data.",
"description": "Shows ocular statuses and forum post reactions.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Shows ocular statuses and forum post reactions.",
"description": "Shows ocular statuses and forum post reactions. Uses my-ocular.jeffalo.net to obtain data.",

{
"name": "Profile statistics",
"description": "Shows statistics from ScratchDB on user profiles.",
"description": "Shows statistics on user profiles.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Shows statistics on user profiles.",
"description": "Shows statistics from ScratchDB on user profiles.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably because he added it on the credits? I don't know, but it's better to expose it better.

Comment thread addons/scratchstats/addon.json Outdated
@apple502j apple502j changed the title Fix gramamar and wording Fix grammar and wording Feb 24, 2022
@apple502j

Copy link
Copy Markdown
Member

"Gramamar" LMAO
image

Comment thread addons-l10n/en/disable-auto-save.json
Comment thread addons/scratch-notifier/comment-emojis.js
Comment thread security.md
@cobaltt7
cobaltt7 requested review from Hans5958, apple502j and mxmou and removed request for Hans5958 February 25, 2022 04:29
Comment on lines -2 to +3
"name": "Hide Tutorials button",
"description": "Hides the Tutorials button in the editor menu bar.",
"name": "Hidden \"Tutorials\" button",
"description": "Hides the \"Tutorials\" button from the editor menu bar.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems counterintuitive because in hindsight, it could imply something it just adds a hidden button (and we think like, why?), and not hide the button itself.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also applies to other "hide XYZ" addons.

Comment on lines -2 to +3
"name": "More links",
"description": "Adds links for URLs pointing outside scratch.mit.edu.",
"name": "More clickable links",
"description": "Makes URLs pointing outside scratch.mit.edu clickable.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose links are clickable in the first place?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, "clickable" part is redundant.

@mxmou mxmou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Descriptions of addons that allow something to be customized should probably begin with "allows you to change" and not "changes".

Comment thread _locales/en/messages.json
},
"scratchAddonsThemeDescription": {
"message": "This allows you to switch between light and dark themes for this settings page, and the extension's popup."
"message": "This allows you to switch between light and dark themes for this settings page and the extension's popup."

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could "extension popup" be used instead for consistency?

{
"name": "Profile page banner",
"description": "Turns the featured project on any user's profile into a nice-looking banner.",
"description": "Turns the featured project on any user's profile into a larger banner.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Wider" would be more accurate.

"name": "Better forum quoter",
"description": "Select text in a forum post and click quote in the bottom right corner to only quote the select text.",
"name": "Partial forum post quoter",
"description": "Allows you to only quote text you have selected when you press \"quote\", if there is text selected.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "if there is text selected" necessary?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary IMO, it's obvious that you can't quote selected text if you select nothing.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i went back on forth on this one, i didn't want it to sound like you can't quote anything without text selected

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it would sound like that. We don't remove features unless it explicitly says so.

{
"type": "notice",
"text": "On macOS, use the Option key instead of the Alt key and Command key instead of the Control key.",
"text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Command\" key instead of the \"Ctrl\" key.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Command\" key instead of the \"Ctrl\" key.",
"text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Cmd\" key instead of the \"Ctrl\" key.",

{
"name": "Save blocks as image",
"description": "Right click the code area to export blocks as SVG/PNG images.",
"description": "Adds options to right-click menus to export blocks as SVG/PNG images.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Adds options to right-click menus to export blocks as SVG/PNG images.",
"description": "Adds options to the code area right-click menu to export blocks as SVG/PNG images.",

Comment on lines -2 to +3
"name": "Old studio layout",
"description": "Reverts the layout of the studio page back to the one used before the studio update or the one previously available as part of the Scratch 2.0 \u2192 3.0 addon.",
"name": "2.0 studio layout",
"description": "Reverts the layout of the studio page to look like Scratch 2.0 or how it looked using the \"Scratch 2.0 \u2192 3.0\" addon.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use "Scratch 2.0" to refer to 2.0-styled (scratchr2) pages.

{
"name": "Paint costume by default",
"description": "Changes the default action of \"Choose a Sprite/Costume/Backdrop/Sound\" buttons, which open the library by default.",
"name": "\"Paint costume\" by default",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Paint costume" is not the name of any Scratch feature, so it doesn't need quotes.

{
"name": "Scratch Notifier",
"description": "Notifications on new Scratch messages. Click the notification to go straight to the message (comment, project, etc.)",
"description": "Receive notifications when you get new Scratch messages. Click the notification to go straight to the message (comment, project, etc.)",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed imperative from a lot of other addon descriptions - is it really appropriate here?

Comment on lines -2 to +3
"name": "YouTube full screen",
"description": "Enables the full screen button in Scratch's YouTube video player.",
"name": "YouTube fullscreen",
"description": "Enables the fullscreen button in Scratch's YouTube video player.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YouTube screenshot showing "Full screen"

Comment on lines 2 to +3
"name": "True forums YouTube links",
"description": "Replaces links to the embedded site with real YouTube links.",
"description": "Replaces links to Scratch's YouTube embed page with real YouTube links.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be consistent with youtube-fullscreen.

@mxmou

mxmou commented Feb 25, 2022

Copy link
Copy Markdown
Member

If we're changing capitalization and quotes, could #2799 (comment) be addressed fully?

@apple502j apple502j added priority: 3 Medium priority. Includes bugs and useful features scope: addon Related to one or multiple addons scope: documentation Related to documentation and help resources labels Feb 25, 2022
@apple502j apple502j added scope: meta Related to the meta of the development (repository, store, etc) scope: webpages Related to the web pages (settings page, pop-up, etc) labels Feb 25, 2022

@apple502j apple502j left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Schema validation failures, word changes, and credit fixes (should not have prepositions)

{
"name": "Do not shift pasted items",
"description": "Paste copied items at their original position instead of shifted slightly in the costume editor.",
"name": "Unshifted pasted items",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old name is better; the addon does not "unshift", it just prevents it from shifting. (Same way people don't say "uneaten cake".)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "No shift" haha

{
"name": "Extra key support",
"description": "Adds more keys to the \"key () pressed?\" and \"when () key pressed\" block dropdowns, such as enter, dot, comma, and more.",
"description": "Adds more keys to the \"key () pressed?\" and \"when () key pressed\" block dropdowns, such as \"Enter\", period (full stop), comma, and more.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The letter is called "dot" in computing context, not "period" or "full stop", according to "en period wikipedia full stop com".

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chrome calls the key (not the character) "period".
image

{
"type": "warning",
"text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag, exclamation mark and more. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.",
"text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag (pound) and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag (pound) and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.",
"text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.",

"Pound" is often used to refer to £ sign.

{
"name": "Do not automatically run duplicated blocks",
"description": "Fixes a bug in the Scratch editor, where duplicating a block and attaching it to a script causes the script to run.",
"name": "Not-automatically-ran duplicated blocks",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not German. Do not hyphenate words, it's okay not to nounify in this case.

Comment thread addons/forum-copy-code/addon.json Outdated
},
{
"name": "ScratchDB",
"url": "http://scratchdb.lefty.one/v3/docs/",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"url": "http://scratchdb.lefty.one/v3/docs/",
"link": "https://scratchdb.lefty.one/v3/docs/",

},
{
"name": "my-ocular.jeffalo.net",
"link": "https://ocular.jeffalo.net",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"link": "https://ocular.jeffalo.net",
"link": "https://ocular.jeffalo.net/",

{
"name": "my-ocular.jeffalo.net",
"link": "https://ocular.jeffalo.net",
"note": "to obtain data",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"note": "to obtain data",
"note": "data source",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not just "data"?

{
"name": "ScratchDB",
"link": "http://scratchdb.lefty.one/v3/docs/",
"note": "for information",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"note": "for information",
"note": "statistics data",

{
"name": "ScratchDB",
"url": "http://scratchdb.lefty.one/v3/docs/",
"note": "for information",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"note": "for information",
"note": "search result",

@Hans5958

Copy link
Copy Markdown
Member

Use more consistent language 2: Electric Boogaloo

@cobaltt7
cobaltt7 marked this pull request as draft March 10, 2022 22:19
Co-authored-by: apple502j <33279053+apple502j@users.noreply.github.com>
@cobaltt7 cobaltt7 closed this Aug 2, 2022
@cobaltt7

cobaltt7 commented Oct 11, 2022 via email

Copy link
Copy Markdown
Contributor Author

@mxmou

mxmou commented Oct 11, 2022

Copy link
Copy Markdown
Member

@RedGuy12 You already closed this two months ago.

@cobaltt7

Copy link
Copy Markdown
Contributor Author

i sent that two months ago why did it just now post

@WorldLanguages

Copy link
Copy Markdown
Member

Many weird notifications today - looks like some actions on the GitHub website took 2 months to reflect...?

@Samq64

Samq64 commented Oct 12, 2022

Copy link
Copy Markdown
Member

I have an unread ghost message from around that time too...

@Samq64 Samq64 mentioned this pull request Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: 3 Medium priority. Includes bugs and useful features scope: addon Related to one or multiple addons scope: documentation Related to documentation and help resources scope: meta Related to the meta of the development (repository, store, etc) scope: webpages Related to the web pages (settings page, pop-up, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants