Skip to content

Decide on the naming convention of sketch, Sketch, cloud, and Cloud shown in the UI #1884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
3 tasks done
kittaakos opened this issue Feb 13, 2023 · 0 comments
Open
3 tasks done
Assignees
Labels
phase: design Work is in the design phase topic: cloud Related to Arduino Cloud and cloud sketches type: imperfection Perceived defect in any part of project

Comments

@kittaakos
Copy link
Contributor

Describe the problem

Originally from here:

Should "cloud" be capitalized?

I'm not a fan of the recent trend I've observed of sometimes capitalizing "sketch" in sentences, since that is not a proper noun, but if "cloud" is short for the "Arduino Cloud" service (as opposed to being a reference to the general concept of "the cloud"), then this is a proper noun and so should be capitalized.

Response from here:

Should "cloud" be capitalized?

I will leave this decision to you. Whichever you think is the best.

the recent trend I've observed of sometimes capitalizing "sketch" in sentences

I found the following translations from this PR where the "sketch" is capitalized in a sentence. (I hope I did not leave out anything):

These have not changed in this PR or recently:

'Pulling this Sketch from the Cloud will overwrite its local version. Are you sure you want to continue?'

'Public. Anyone with the link can view the Sketch.'

'This is a Public Sketch. Before pushing, make sure any sensitive information is defined in arduino_secrets.h files. You can make a Sketch private from the Share panel.'

These have not changed, and the sentence starts with "sketch":

"Sketch '{0}' must be verified before starting a debug session. Please verify the sketch and start debugging again. Do you want to verify the sketch now?",

These are command or menu labels, so capitalized "sketch" is expected:

label: nls.localize('arduino/sketch/new', 'New Sketch'),

label: nls.localize('arduino/sketch/showFolder', 'Show Sketch Folder'),

nls.localize('arduino/menu/sketch', 'Sketch')

name: nls.localize('arduino/sketch/sketch', 'Sketch'),

label: nls.localize('arduino/sketch/archiveSketch', 'Archive Sketch'),

label: nls.localize('arduino/cloudSketch/new', 'New Cloud Sketch'),

label={nls.localize('arduino/sketchbook/newSketch', 'New Sketch')}

title: nls.localize('arduino/cloud/shareSketch', 'Share Sketch'),

These are new and were requested in the design doc:

Let me know what to do. Thanks!

The request for the design decision is from here:

I will leave this decision to you. Whichever you think is the best.

I surveyed the Arduino Cloud-related content on arduino.cc and found that "Cloud" is capitalized in contexts equivalent to "Cloud sketch". So I think it should be capitalized.

the sentence starts with "sketch":

These are command or menu labels, so capitalized "sketch" is expected:

Yes, in cases where the work occurs at the start of a sentence or contexts where the standard for capitalization style is "title case", there is no question that "Sketch" is correct.

These are new and were requested in the design doc:

Then I guess I would have to request the input of the designers.

@91volt @gmarchiarduino please provide clear rules for when "sketch" should and should not be capitalized. As I've said several times in the past, it would be very helpful to have this sort of thing documented in a style guide.

To reproduce

  • Start IDE2 2.0.3.
  • The sketch and cloud words are used with capital and lowercase.

Expected behavior

Consistent cloud and sketch naming and casing in the IDE2 UI.

Arduino IDE version

2.0.3

Operating system

macOS

Operating system version

12.5.1

Additional context

No response

Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the latest nightly build
  • My report contains all necessary details
@kittaakos kittaakos added type: imperfection Perceived defect in any part of project phase: design Work is in the design phase labels Feb 13, 2023
@kittaakos kittaakos added the topic: cloud Related to Arduino Cloud and cloud sketches label Apr 13, 2023
@per1234 per1234 changed the title Decide on the naming convention of sketch, Sketch, cloud, and Cloud shown in the IDE2 UI Decide on the naming convention of sketch, Sketch, cloud, and Cloud shown in the UI Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
phase: design Work is in the design phase topic: cloud Related to Arduino Cloud and cloud sketches type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

2 participants