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

Add some comments to explain return codes. #8365

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Conversation

anhu
Copy link
Member

@anhu anhu commented Jan 21, 2025

Fixes #8363

Copy link
Contributor

@dgarske dgarske left a comment

Choose a reason for hiding this comment

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

Can you also tackle the new code spell errors?

Error: ./tests/api.c:8798: re-using ==> reusing
Error: ./tests/api.c:8862: re-using ==> reusing
Error: ./tests/api.c:9502: re-using ==> reusing
Error: ./tests/api.c:55870: aroun ==> around
Error: ./tests/api.c:68106: re-using ==> reusing
Error: ./tests/api.c:68213: re-using ==> reusing
Error: ./examples/benchmark/tls_bench.c:164: brunch ==> branch
Error: ./mcapi/mcapi_test.c:552: brunch ==> branch
Error: ./src/pk.c:12364: adter ==> after
Error: ./wolfcrypt/test/test.c:50123: brunch ==> branch
Error: ./wolfcrypt/src/ge_448.c:372: multplication ==> multiplication
Error: ./IDE/STM32Cube/wolfssl_example.c:169: brunch ==> branch
Error: ./wolfssl/internal.h:5785: re-using ==> reusing
Error: ./wolfssl/ssl.h:2983: sytem ==> system

@dgarske dgarske self-requested a review January 21, 2025 23:10
@dgarske dgarske assigned wolfSSL-Bot and unassigned anhu Jan 21, 2025
@ell1e
Copy link

ell1e commented Jan 21, 2025

The new API comments look great!

@anhu
Copy link
Member Author

anhu commented Jan 21, 2025

@ell1e ,

The new API comments look great!

Thank you for your kind words and thank you for requesting them. I love it when people appreciate the work we do!

Warm regards, Anthony

Copy link
Contributor

@dgarske dgarske left a comment

Choose a reason for hiding this comment

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

Approving / merging with unrelated code spell errors.

@dgarske dgarske merged commit efb8a22 into wolfSSL:master Jan 21, 2025
154 of 155 checks passed
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

Successfully merging this pull request may close these issues.

[Bug]: Documentation bug, "WOLFSSL_ERROR_ZERO_RETURN" has no description
4 participants