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

MAX32666: MXC_UART_Init misleading docstring return value #1144

Open
JordanAceto opened this issue Aug 28, 2024 · 0 comments
Open

MAX32666: MXC_UART_Init misleading docstring return value #1144

JordanAceto opened this issue Aug 28, 2024 · 0 comments

Comments

@JordanAceto
Copy link

The docstring for MXC_UART_Init() says that "If successful, the actual clock frequency is returned...". However, on success this function returns E_NO_ERROR bubbled up from MXC_UART_RevA_Init()

The part of the docstring that is misleading is here:

* @return If successful, the actual clock frequency is returned. Otherwise, see

The actual return value comes from here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant