Skip to content

doc/doxygen: fix typo in getting started page#10113

Merged
miri64 merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/doc/getting_started_typo
Oct 5, 2018
Merged

doc/doxygen: fix typo in getting started page#10113
miri64 merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/doc/getting_started_typo

Conversation

@aabadie
Copy link
Copy Markdown
Contributor

@aabadie aabadie commented Oct 5, 2018

Contribution description

This PR fixes a small typo in the getting started page of the doxygen documentation.

Testing procedure

run make doc and read the getting started page in the generated documentation.

Issues/PRs references

None

@aabadie aabadie added Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Oct 5, 2018
@aabadie aabadie requested a review from miri64 October 5, 2018 07:49

* `APPLICATION`: should contain the (unique) name of your application
* `BOARD`: specifies the platform the application should be build for by
* `BOARD`: specifies the platform the application should be built for by
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think past tense should be used here (as the application isn't built yet ;-)), but maybe one of our native speakers can clarify. @danpetry, @kb2ma?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use another verb, let's say do, then should be done seems better than should be do, right ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mh... You are right. 😄


* `APPLICATION`: should contain the (unique) name of your application
* `BOARD`: specifies the platform the application should be build for by
* `BOARD`: specifies the platform the application should be built for by
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mh... You are right. 😄

@miri64 miri64 merged commit 6bfd333 into RIOT-OS:master Oct 5, 2018
@aabadie aabadie deleted the pr/doc/getting_started_typo branch October 5, 2018 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants