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.

Sign up for GitHub

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

Jump to bottom

[Documentation] Missleading documentation for uart_write_blocking() #1481

Closed
DanielBender226 opened this issue Aug 22, 2023 · 2 comments
Closed

[Documentation] Missleading documentation for uart_write_blocking() #1481

DanielBender226 opened this issue Aug 22, 2023 · 2 comments
Assignees
@peterharperuk
Labels
documentation Improvements or additions to documentation
Milestone
2.0.0

Comments

@DanielBender226
Copy link

The doc says that "This function will block until all the data has been sent to the UART", but it´s only blocking until all data has been sent to the tx buffer.
I think this documentation should be clarified that this function is only blocking until the data is sent to the buffer and not until the data is actually sent out.
@lurch
Copy link
Contributor

lurch commented Aug 22, 2023

See also the discussion in #1274

@kilograham kilograham added the documentation Improvements or additions to documentation label Dec 14, 2023
@kilograham kilograham added this to the 1.6.0 milestone Dec 14, 2023
@kilograham kilograham modified the milestones: 1.6.0, 1.5.2 May 19, 2024
peterharperuk added a commit to peterharperuk/pico-sdk that referenced this issue Jul 23, 2024
@peterharperuk
Clarify uart write
0c87192 
will block until data "has been sent to the UART transmit buffer"

Fixes raspberrypi#1481
kilograham pushed a commit that referenced this issue Jul 23, 2024
@peterharperuk
Some doc issues (#1772)
5ec4071 
* Fix doxygen for uart example

Fixes #1685

* Clarify uart write

will block until data "has been sent to the UART transmit buffer"

Fixes #1481

* Add note to flash API about erasing sectors

Fixes: #650
@lurch
Copy link
Contributor

lurch commented Jul 24, 2024

Fixed by #1772

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peterharperuk peterharperuk

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
5 participants
@lurch @kilograham @liamfraser @peterharperuk @DanielBender226