Skip to content

Commit 96fee4c

Browse files
authored
[skip changelog] Fix typos in documentation (#786)
1 parent e5924c9 commit 96fee4c

File tree

8 files changed

+14
-14
lines changed

8 files changed

+14
-14
lines changed

cli/debug/debug.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func NewCommand() *cobra.Command {
5454
debugCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
5555
debugCommand.Flags().StringVarP(&port, "port", "p", "", "Debug port, e.g.: COM10 or /dev/ttyACM0")
5656
debugCommand.Flags().StringVar(&interpreter, "interpreter", "console", "Debug interpreter e.g.: console, mi, mi1, mi2, mi3")
57-
debugCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Direcory containing binaries for debug.")
57+
debugCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Directory containing binaries for debug.")
5858

5959
return debugCommand
6060
}

cli/globals/args.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func ParseReferenceArgs(args []string, parseArch bool) ([]*ReferenceArg, error)
5555
func ParseReferenceArg(arg string, parseArch bool) (*ReferenceArg, error) {
5656
ret := &ReferenceArg{}
5757
if arg == "" {
58-
return nil, fmt.Errorf("invalid empry core argument")
58+
return nil, fmt.Errorf("invalid empty core argument")
5959
}
6060
toks := strings.SplitN(arg, "@", 2)
6161
if toks[0] == "" {

cli/upload/upload.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func NewCommand() *cobra.Command {
5353

5454
uploadCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
5555
uploadCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
56-
uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Direcory containing binaries to upload.")
56+
uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Directory containing binaries to upload.")
5757
uploadCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
5858
uploadCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
5959
uploadCommand.Flags().StringVarP(&programmer, "programmer", "P", "", "Optional, use the specified programmer to upload or 'list' to list supported programmers.")

client_example/main.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var (
3838
)
3939

4040
// The main function implements an example workflow to show how to interact
41-
// with the gRPC Api exposed by arduino-cli when running in daemon mode.
41+
// with the gRPC API exposed by arduino-cli when running in daemon mode.
4242
func main() {
4343

4444
// Establish a connection with the gRPC server, started with the command:
@@ -50,7 +50,7 @@ func main() {
5050
defer conn.Close()
5151

5252
// To avoid polluting an existing arduino-cli installation, the example
53-
// client uses a temp folder to keep cores, libraries and the likes.
53+
// client uses a temp folder to keep cores, libraries and the like.
5454
// You can point `dataDir` to a location that better fits your needs.
5555
dataDir, err = ioutil.TempDir("", "arduino-rpc-client")
5656
if err != nil {
@@ -92,7 +92,7 @@ func main() {
9292
log.Println("calling Init")
9393
instance := initInstance(client)
9494

95-
// With a brand new instance, the first operation should always be updatating
95+
// With a brand new instance, the first operation should always be updating
9696
// the index.
9797
log.Println("calling UpdateIndex")
9898
callUpdateIndex(client, instance)
@@ -138,7 +138,7 @@ func main() {
138138
// debugClient := dbg.NewDebugClient(conn)
139139
// debugStreamingClient, err := debugClient.Debug(context.Background())
140140
// if err != nil {
141-
// log.Fatalf("debug steraming open error: %s\n", err)
141+
// log.Fatalf("debug streaming open error: %s\n", err)
142142
// }
143143
// log.Println("calling Debug(arduino:samd:mkr1000, hello.ino)")
144144
// callDebugger(debugStreamingClient, instance)

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ updated or not.
261261

262262
## Internationalization (i18n)
263263

264-
In order to support i18n in the cli, any messages that are intended to be translated
264+
In order to support i18n in the CLI, any messages that are intended to be translated
265265
should be wrapped in a call to `i18n.Tr`. This call allows us to build a catalog of
266266
translatable strings, replacing the reference string at runtime with the localized value.
267267

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ These are available from the [releases page](https://github.com/arduino/arduino-
7575

7676
#### Nightly builds
7777

78-
These builds are generated everyday at 01:00 GMT from the `master` branch and
78+
These builds are generated every day at 01:00 GMT from the `master` branch and
7979
should be considered unstable. In order to get the latest nightly build
8080
available for the supported platform, use the following links:
8181

@@ -84,7 +84,7 @@ Platform | | |
8484
Linux | [Nightly Linux 32 bit] | [Nightly Linux 64 bit] |
8585
Linux ARM | [Nightly Linux ARM 32 bit] | [Nightly Linux ARM 64 bit] |
8686
Windows | [Nightly Windows 32 bit] | [Nightly Windows 64 bit] |
87-
Mac OSX | | [Mac OSX] |
87+
Mac OSX | | [Nightly Mac OSX] |
8888

8989
[Nightly Linux 64 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_64bit.tar.gz
9090
[Nightly Linux 32 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_32bit.tar.gz

docs/package_index_json-specification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Finally, let's see how `PLATFORMS` are made.
193193
Each PLATFORM describes a core for a specific architecture. The fields needed are:
194194

195195
* `name`: the extended name of the platform that is displayed on the Boards Manager GUI
196-
* `architecture`: is the architecture of the plaftorm (avr, sam, etc...). It must match the architecture of the core as explained in the [Arduino platform specification](platform-specification.md#hardware-folders-structure)
196+
* `architecture`: is the architecture of the platform (avr, sam, etc...). It must match the architecture of the core as explained in the [Arduino platform specification](platform-specification.md#hardware-folders-structure)
197197
* `version`: the version of the platform.
198198
* `category`: this field is reserved, a 3rd party core must set it to `Contributed`
199199
* `help`/`online`: is a URL that is displayed on the Arduino IDE's Boards Manager as an "Online Help" link

docs/platform-specification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -475,12 +475,12 @@ The port selected via the IDE or [`arduino-cli upload`](https://arduino.github.i
475475

476476
### Upload using an external programmer
477477

478-
**TODO...**
478+
**TODO...**<br>
479479
The platform.txt associated with the selected programmer will be used.
480480

481481
### Burn Bootloader
482482

483-
**TODO...**
483+
**TODO...**<br>
484484
The platform.txt associated with the selected board will be used.
485485

486486
## Custom board options
@@ -555,7 +555,7 @@ There is no limit to the number of custom menus that can be defined.
555555

556556
## Referencing another core, variant or tool
557557

558-
Inside the boards.txt we can define a board that uses a core provided by another vendor/mantainer using the syntax **VENDOR_ID:CORE_ID**. For example, if we want to define a board that uses the "arduino" core from the "arduino" vendor we should write:
558+
Inside the boards.txt we can define a board that uses a core provided by another vendor/maintainer using the syntax **VENDOR_ID:CORE_ID**. For example, if we want to define a board that uses the "arduino" core from the "arduino" vendor we should write:
559559

560560
[....]
561561
myboard.name=My Wonderful Arduino Compatible board

0 commit comments

Comments
 (0)