Skip to content

drivers/net: Fix netdev_driver_t doc#14657

Merged
jia200x merged 1 commit intoRIOT-OS:masterfrom
maribu:netdev_doc
Aug 4, 2020
Merged

drivers/net: Fix netdev_driver_t doc#14657
jia200x merged 1 commit intoRIOT-OS:masterfrom
maribu:netdev_doc

Conversation

@maribu
Copy link
Copy Markdown
Member

@maribu maribu commented Jul 30, 2020 •
edited
Loading

Contribution description

No content-wise changes, only changed:

  • Fix indent
  • Use @reval instead of @return when referring to a single return value
  • Use term "frame" instead of "packet"

Testing procedure

Read the doc

Issues/PRs references

None

@maribu maribu requested review from jia200x and miri64 July 30, 2020 09:34
@maribu maribu added Area: doc Area: Documentation Area: drivers Area: Device drivers Area: network Area: Networking Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer labels Jul 30, 2020
@maribu
Copy link
Copy Markdown
Member Author

maribu commented Jul 30, 2020

Sorry, a change sneaked in. Now it is only doc change

@maribu
Copy link
Copy Markdown
Member Author

maribu commented Jul 30, 2020

And one closing parenthesis was missing. (I believe I was fast enough that nobody started to review, so I just amended it into the existing commit.)

@benpicco
Copy link
Copy Markdown
Contributor

benpicco commented Jul 30, 2020

Travis' whitespacecheck is not happy

@maribu
drivers/net: Fix netdev_driver_t doc
86513dc 
- Fix indent
- Use @reval instead of @return when referring to a single return value
- Use term "frame" instead of "packet"
@maribu maribu mentioned this pull request Jul 30, 2020
Merged
1 task
@maribu maribu added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jul 30, 2020
@fjmolinas
Copy link
Copy Markdown
Contributor

fjmolinas commented Aug 4, 2020

All green here @jia200x @miri64 do you agree with the doc change?

@jia200x
Copy link
Copy Markdown
Member

jia200x commented Aug 4, 2020

I'm fine with it

jia200x
jia200x approved these changes Aug 4, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@jia200x jia200x left a comment

Choose a reason for hiding this comment

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

ACK

@jia200x jia200x merged commit 7967066 into RIOT-OS:master Aug 4, 2020
@miri64
Copy link
Copy Markdown
Member

miri64 commented Aug 4, 2020

All green here @jia200x @miri64 do you agree with the doc change?

I do.

@maribu
Copy link
Copy Markdown
Member Author

maribu commented Aug 4, 2020

Thanks for the reviews :-)

@maribu maribu deleted the netdev_doc branch August 4, 2020 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jia200x jia200x jia200x approved these changes

@miri64 miri64 Awaiting requested review from miri64

Assignees

No one assigned

Labels

Area: doc Area: Documentation Area: drivers Area: Device drivers Area: network Area: Networking CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@maribu @benpicco @fjmolinas @jia200x @miri64