Skip to content
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

doc: fix typo in XRECVFROM command #3596

Merged
merged 1 commit into from Jan 6, 2021

Conversation

ru-fu
Copy link

@ru-fu ru-fu commented Jan 4, 2021

Fix a typo in the example for the AT#XRECVFROM command.

Signed-off-by: Ruth Fuchss ruth.fuchss@nordicsemi.no

@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Jan 4, 2021
@didrikr
Copy link
Contributor

didrikr commented Jan 4, 2021

While this will remove the reference to the non-existent #UDPRECVFROM command, the example does not match the syntax.
In the example: AT#UDPRECVFROM="test.server.com",1234
Syntax: #XRECVFROM[=<size>]
Which form is correct?

@ru-fu
Copy link
Author

ru-fu commented Jan 4, 2021

While this will remove the reference to the non-existent #UDPRECVFROM command, the example does not match the syntax.
In the example: AT#UDPRECVFROM="test.server.com",1234
Syntax: #XRECVFROM[=<size>]
Which form is correct?

@lats1980 @junqingzou ?

Copy link
Contributor

@lats1980 lats1980 left a comment

Choose a reason for hiding this comment

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

Approve! Thanks for the fix. Please also change the syntax in the example.

Fix a typo in the example for the AT#XRECVFROM command.

Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
@ru-fu
Copy link
Author

ru-fu commented Jan 5, 2021

Updated - please check again.

@junqingzou
Copy link
Contributor

junqingzou commented Jan 6, 2021

While this will remove the reference to the non-existent #UDPRECVFROM command, the example does not match the syntax.
In the example: AT#UDPRECVFROM="test.server.com",1234
Syntax: #XRECVFROM[=<size>]
Which form is correct?

@lats1980 @junqingzou ?

This was misunderstanding of UDP recvfrom() API in the beginning, that the remote host is the output instead of input of this API. Thus we removed the remote host in the command syntax. New syntax: #XRECVFROM[=<size>]

@jfischer-no jfischer-no merged commit 63f68eb into nrfconnect:master Jan 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
6 participants