Skip to content

[skip changelog] Correct typos in documentation #786

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

Merged
merged 1 commit into from
Jul 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion cli/debug/debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func NewCommand() *cobra.Command {
debugCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
debugCommand.Flags().StringVarP(&port, "port", "p", "", "Debug port, e.g.: COM10 or /dev/ttyACM0")
debugCommand.Flags().StringVar(&interpreter, "interpreter", "console", "Debug interpreter e.g.: console, mi, mi1, mi2, mi3")
debugCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Direcory containing binaries for debug.")
debugCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Directory containing binaries for debug.")

return debugCommand
}
Expand Down
2 changes: 1 addition & 1 deletion cli/globals/args.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func ParseReferenceArgs(args []string, parseArch bool) ([]*ReferenceArg, error)
func ParseReferenceArg(arg string, parseArch bool) (*ReferenceArg, error) {
ret := &ReferenceArg{}
if arg == "" {
return nil, fmt.Errorf("invalid empry core argument")
return nil, fmt.Errorf("invalid empty core argument")
}
toks := strings.SplitN(arg, "@", 2)
if toks[0] == "" {
Expand Down
2 changes: 1 addition & 1 deletion cli/upload/upload.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func NewCommand() *cobra.Command {

uploadCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
uploadCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Direcory containing binaries to upload.")
uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", "Directory containing binaries to upload.")
uploadCommand.Flags().BoolVarP(&verify, "verify", "t", false, "Verify uploaded binary after the upload.")
uploadCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, "Optional, turns on verbose mode.")
uploadCommand.Flags().StringVarP(&programmer, "programmer", "P", "", "Optional, use the specified programmer to upload or 'list' to list supported programmers.")
Expand Down
8 changes: 4 additions & 4 deletions client_example/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var (
)

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

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

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

// With a brand new instance, the first operation should always be updatating
// With a brand new instance, the first operation should always be updating
// the index.
log.Println("calling UpdateIndex")
callUpdateIndex(client, instance)
Expand Down Expand Up @@ -138,7 +138,7 @@ func main() {
// debugClient := dbg.NewDebugClient(conn)
// debugStreamingClient, err := debugClient.Debug(context.Background())
// if err != nil {
// log.Fatalf("debug steraming open error: %s\n", err)
// log.Fatalf("debug streaming open error: %s\n", err)
// }
// log.Println("calling Debug(arduino:samd:mkr1000, hello.ino)")
// callDebugger(debugStreamingClient, instance)
Expand Down
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ updated or not.

## Internationalization (i18n)

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

Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ These are available from the [releases page](https://github.com/arduino/arduino-

#### Nightly builds

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

Expand All @@ -84,7 +84,7 @@ Platform | | |
Linux | [Nightly Linux 32 bit] | [Nightly Linux 64 bit] |
Linux ARM | [Nightly Linux ARM 32 bit] | [Nightly Linux ARM 64 bit] |
Windows | [Nightly Windows 32 bit] | [Nightly Windows 64 bit] |
Mac OSX | | [Mac OSX] |
Mac OSX | | [Nightly Mac OSX] |

[Nightly Linux 64 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_64bit.tar.gz
[Nightly Linux 32 bit]: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_32bit.tar.gz
Expand Down
2 changes: 1 addition & 1 deletion docs/package_index_json-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Finally, let's see how `PLATFORMS` are made.
Each PLATFORM describes a core for a specific architecture. The fields needed are:

* `name`: the extended name of the platform that is displayed on the Boards Manager GUI
* `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)
* `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)
* `version`: the version of the platform.
* `category`: this field is reserved, a 3rd party core must set it to `Contributed`
* `help`/`online`: is a URL that is displayed on the Arduino IDE's Boards Manager as an "Online Help" link
Expand Down
6 changes: 3 additions & 3 deletions docs/platform-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,12 +471,12 @@ The port selected via the IDE or [`arduino-cli upload`](https://arduino.github.i

### Upload using an external programmer

**TODO...**
**TODO...**<br>
The platform.txt associated with the selected programmer will be used.

### Burn Bootloader

**TODO...**
**TODO...**<br>
The platform.txt associated with the selected board will be used.

## Custom board options
Expand Down Expand Up @@ -551,7 +551,7 @@ There is no limit to the number of custom menus that can be defined.

## Referencing another core, variant or tool

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:
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:

[....]
myboard.name=My Wonderful Arduino Compatible board
Expand Down