Skip to content

Fix typos in the documentation #623

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.

Sign up for GitHub

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
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Fix typos in the documentation #623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51996d3
Fix typo in image.class.ts documentation
Deltaspace0 Sep 29, 2025
7020516
docs: fix typo in screen-test README
Deltaspace0 Oct 1, 2025
a6d7bff
docs: fix typos in ScreenClass documentation
Deltaspace0 Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions core/nut.js/lib/screen.class.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,19 +139,19 @@ export class ScreenClass {
}

/**
* {@link width} returns the main screen width
* {@link width} returns the main screen width
* This refers to the hardware resolution.
* Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher width in in actual pixels
* Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher width in actual pixels
*/
public width() {
this.providerRegistry.getLogProvider().debug(`Fetching screen width`);
return this.providerRegistry.getScreen().screenWidth();
}

/**
* {@link height} returns the main screen height
* {@link height} returns the main screen height
* This refers to the hardware resolution.
* Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher height in in actual pixels
* Screens with higher pixel density (e.g. retina displays in MacBooks) might have a higher height in actual pixels
*/
public height() {
this.providerRegistry.getLogProvider().debug(`Fetching screen height`);
Expand Down
2 changes: 1 addition & 1 deletion core/shared/lib/objects/image.class.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export class Image {
}

/**
* {@link toBGR} converts an {@link Image} from RGB color mode to RGB
* {@link toBGR} converts an {@link Image} from RGB color mode to BGR
*/
public async toBGR(): Promise<Image> {
if (this.colorMode === ColorMode.BGR) {
Expand Down
2 changes: 1 addition & 1 deletion examples/screen-test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Following this scheme loading of platform specific images would be possible with
## [`find`](https://nut-tree.github.io/apidoc/classes/screen.html#find)

`find` takes a filename relative to the configured [resourceDirectory](#resourcedirectory) and tries to find a match on the main screen.
It is possible to override the the [configured matching confidence](#confidence) and search region providing [LocationParameters](https://nut-tree.github.io/apidoc/classes/locationparameters.html).
It is possible to override the [configured matching confidence](#confidence) and search region providing [LocationParameters](https://nut-tree.github.io/apidoc/classes/locationparameters.html).
In case of a match, the corresponding [Region](https://nut-tree.github.io/apidoc/classes/region.html) on screen is returned.

```js
Expand Down