Skip to content

Commit 219c6a7

Browse files
authored
Fix capitalization inconsistencies in break-related terminology (#1688)
* Fix capitalization inconsistencies in break-related terminology across documentation and code * Fix other capitalization inconsistencies
1 parent 4a3d8df commit 219c6a7

File tree

6 files changed

+22
-22
lines changed

6 files changed

+22
-22
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,12 @@ Here are the preferences editable via the app. If values in the app does not sui
215215
- `monitorDnd` - monitor DND mode
216216
- `checkNewVersion` - check for new versions
217217

218-
#### Editing Break ideas
218+
#### Editing break ideas
219219
In the preferences file, change `useIdeasFromSettings: false,` to `useIdeasFromSettings: true,` and edit `breakIdeas` and `microbreakIdeas`.
220220

221221
Note that when a new *Stretchly* version with new break ideas is out, your custom ideas will not be overwritten. You can reset break ideas to the latest defaults when you "Restore defaults" from Preferences window.
222222

223-
##### Using HTML in Break Ideas
223+
##### Using HTML in break ideas
224224
You can use simple HTML formatting in custom break ideas to enhance their appearance:
225225

226226
**Allowed HTML elements:**
@@ -258,7 +258,7 @@ Supported image formats: PNG, JPEG, WebP, GIF. Only images from the local `image
258258

259259
Stretchly sanitizes all HTML to keep break windows secure by removing any unsupported tags or unsafe content.
260260

261-
#### Editing Break notification interval [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
261+
#### Editing break notification interval [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
262262
In the preferences file, change `breakNotificationInterval: 30000,` to whatever value you want. 30000 is 30 seconds. Same goes for Mini breaks.
263263

264264
#### Editing sunrise time to pause breaks until morning
@@ -276,7 +276,7 @@ In the preferences file, you can edit `microbreakPostpone` and `breakPostpone` t
276276
#### New version notification [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
277277
In the preferences file, set `notifyNewVersion: false,` to disable new version notification.
278278

279-
#### Sounds at the start of Breaks [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
279+
#### Sounds at the start of breaks [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
280280
To configure the sound when a break starts, set for example `"miniBreakStartSound": "crystal-glass"`. Same for `longBreakStartSound`. Accepted values: `silence`, `crystal-glass`, `wind-chime`, `tic-toc`, `reverie`. Setting the value to `silence` means no sound will be played.
281281

282282
#### Different sound for Mini and Long breaks
@@ -291,7 +291,7 @@ In the preferences file, set `naturalBreaksInactivityResetTime` to your preferre
291291
#### Volume for break sounds [![Contributor Preferences](https://img.shields.io/badge/Contributor_Preferences-✔-success)](#contributor-preferences)
292292
In the preferences file, set `volume` to your preferred value. Default value is `1`, which is 100% volume. Set it, for example, to `0.61` for 61% volume. This applies to both start and end break sounds.
293293

294-
#### Postpone/Finish Break Shortcut
294+
#### Postpone/finish break shortcut
295295
In the preferences file, set `endBreakShortcut` to your preferred value. We do not validate this input, so please check [Electron's documentation](https://www.electronjs.org/docs/api/accelerator) for available values for key and modifier. When a given accelerator is already taken by other applications, this call will silently fail. This behavior is intended by operating systems, since they don't want applications to fight for global shortcuts.
296296

297297
If you'd like to disable the shortcut, set value to empty string `""`.
@@ -308,15 +308,15 @@ If you want breaks to wait for you to finish them manually instead of automatica
308308

309309
Once enabled, the break behaves normally until it reaches 100%, then the window switches to showing elapsed time since the break started. You must press the Finish button or use the `endBreakShortcut` to close the break.
310310

311-
#### Toggle Breaks Shortcut
311+
#### Toggle breaks shortcut
312312

313-
Toggling between Pause Breaks and running breaks.
313+
Toggling between Pause breaks and running breaks.
314314

315315
In the preferences file, set `pauseBreaksToggleShortcut` to your preferred value. We do not validate this input, so please check [Electron's documentation](https://www.electronjs.org/docs/api/accelerator) for available values for key and modifier. When a given accelerator is already taken by other applications, this call will silently fail. This behavior is intended by operating systems, since they don't want applications to fight for global shortcuts.
316316

317317
If you'd like to disable the shortcut, set value to empty string `""`. That's the default value as well.
318318

319-
#### Pause Breaks for Duration Shortcuts
319+
#### Pause breaks for duration shortcuts
320320

321321
You can also set shortcuts to pause breaks for a specific duration by modifying the following values in the preferences file:
322322

@@ -328,13 +328,13 @@ You can also set shortcuts to pause breaks for a specific duration by modifying
328328

329329
If you'd like to disable the shortcuts, set value to empty string `""`. That's the default value as well.
330330

331-
#### Skip to the next Break Shortcut
331+
#### Skip to the next break shortcut
332332

333333
In the preferences file, set `skipToNextScheduledBreakShortcut`, `skipToNextMiniBreakShortcut`, `skipToNextLongBreakShortcut` to your preferred value. We do not validate this input, so please check [Electron's documentation](https://www.electronjs.org/docs/api/accelerator) for available values for key and modifier. When a given accelerator is already taken by other applications, this call will silently fail. This behavior is intended by operating systems, since they don't want applications to fight for global shortcuts.
334334

335335
If you'd like to disable the shortcut, set value to empty string `""`. That's the default value as well.
336336

337-
#### Reset Breaks Shortcut
337+
#### Reset breaks shortcut
338338

339339
In the preferences file, set `resetBreaksShortcut` to your preferred value. We do not validate this input, so please check [Electron's documentation](https://www.electronjs.org/docs/api/accelerator) for available values for key and modifier. When a given accelerator is already taken by other applications, this call will silently fail. This behavior is intended by operating systems, since they don't want applications to fight for global shortcuts.
340340

app/locales/en.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
"toBreak": "Long break",
99
"toMicrobreak": "Mini break",
1010
"skipToTheNext": "Skip to the next",
11-
"resume": "Resume Breaks",
12-
"pause": "Pause Breaks",
11+
"resume": "Resume breaks",
12+
"pause": "Pause breaks",
1313
"forHour": "1 hour",
1414
"for2Hours": "2 hours",
1515
"for5Hours": "5 hours",
1616
"untilMorning": "Until morning",
1717
"indefinitely": "Indefinitely",
18-
"resetBreaks": "Reset Breaks",
18+
"resetBreaks": "Reset breaks",
1919
"quitStretchly": "Quit Stretchly",
2020
"restoreDefaults": "Restore defaults",
2121
"warning": "This will restore app defaults and all your settings will be lost.",
@@ -162,11 +162,11 @@
162162
"dark": "Dark",
163163
"system": "System",
164164
"showBreaksAsRegularWindowsTitle": "Act as regular window:",
165-
"showBreaksAsRegularWindowsInfo": "When enabled, Break windows will become focusable, they won't be 'Always on top' anymore and they will also appear in the taskbar.",
165+
"showBreaksAsRegularWindowsInfo": "When enabled, break windows will become focusable, they won't be 'Always on top' anymore and they will also appear in the taskbar.",
166166
"showBreaksAsRegularWindows": "Show breaks as regular windows",
167-
"screen": "Monitor for Breaks:",
168-
"screenInfo": "When showing breaks on all monitors is disabled, you can choose which one you would like to show your Breaks on.",
169-
"showOnMonitor": "Show Breaks on",
167+
"screen": "Monitor for breaks:",
168+
"screenInfo": "When showing breaks on all monitors is disabled, you can choose which one you would like to show your breaks on.",
169+
"showOnMonitor": "Show breaks on",
170170
"primary": "Primary monitor",
171171
"cursor": "Follow cursor",
172172
"timeToBreakInTray": "Time to break",

app/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -997,7 +997,7 @@ function enterManualAwaitPhase (type, shouldPlaySound) {
997997
}
998998
})
999999
}
1000-
log.info('Stretchly: entering manual finish phase (' + (isMini ? 'Mini' : 'Long') + ' Break)')
1000+
log.info('Stretchly: entering manual finish phase (' + (isMini ? 'Mini' : 'Long') + ' break)')
10011001
}
10021002

10031003
const enterMiniBreakManualContinuation = (shouldPlaySound) => enterManualAwaitPhase('mini', shouldPlaySound)

app/utils/breakShortcuts.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function onShortcut ({ name, settings, log, breakPlanner, functions }) {
3333
}
3434
break
3535
case 'skipToNextScheduledBreakShortcut':
36-
log.info('Stretchly: skipping to next scheduled Break by shortcut')
36+
log.info('Stretchly: skipping to next scheduled break by shortcut')
3737
if (breakPlanner._scheduledBreakType === 'break') {
3838
functions.skipToBreak()
3939
} else if (breakPlanner._scheduledBreakType === 'microbreak') {

app/utils/commands.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ const allExamples = [{
9292
},
9393
{
9494
cmd: 'stretchly long -T "Stretch up!" --noskip',
95-
description: 'Set the next Break\'s title to "Stretch up!"'
95+
description: 'Set the next break\'s title to "Stretch up!"'
9696
},
9797
{
9898
cmd: 'stretchly long -T "Stretch up!" -t "Go stretch!"',

test/breakShortcuts.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ describe('pauseBreaksShortcut', () => {
8383
log
8484
})
8585

86-
expect(log.info).toHaveBeenCalledWith('Stretchly: skipping to next scheduled Break by shortcut')
86+
expect(log.info).toHaveBeenCalledWith('Stretchly: skipping to next scheduled break by shortcut')
8787
expect(skipToBreak).toHaveBeenCalled()
8888
expect(skipToMicrobreak).not.toHaveBeenCalled()
8989
expect(pauseBreaks).not.toHaveBeenCalled()
@@ -104,7 +104,7 @@ describe('pauseBreaksShortcut', () => {
104104
log
105105
})
106106

107-
expect(log.info).toHaveBeenCalledWith('Stretchly: skipping to next scheduled Break by shortcut')
107+
expect(log.info).toHaveBeenCalledWith('Stretchly: skipping to next scheduled break by shortcut')
108108
expect(skipToBreak).not.toHaveBeenCalled()
109109
expect(skipToMicrobreak).toHaveBeenCalled()
110110
expect(pauseBreaks).not.toHaveBeenCalled()

0 commit comments

Comments
 (0)