Remove accidental comment words in stdio.h #2480
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robertrico
reviewed
May 21, 2025
| * in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0 | ||
| * | ||
| * \ingroup pico_stdio | ||
| */ | ||
| int stdio_getchar(void); | ||
|
|
||
| /*! \brief stdio_getchar Alias for \ref putchar that definitely does not go thru the implementation | ||
| /*! \brief Alias for \ref putchar that definitely does not go thru the implementation |
There was a problem hiding this comment.
I wonder if this should be stdio_putchar. The following removals of stdio_getchar perhaps should change to the prototype fn name.
robertrico
reviewed
May 21, 2025
| @@ -186,35 +186,35 @@ int stdio_get_until(char *buf, int len, absolute_time_t until); | |||
| */ | |||
| int stdio_put_string(const char *s, int len, bool newline, bool cr_translation); | |||
|
|
|||
| /*! \brief stdio_getchar Alias for \ref getchar that definitely does not go thru the implementation | |||
There was a problem hiding this comment.
I think this one is right, the others may need to be renamed not removed.
There was a problem hiding this comment.
Yeah I wasn't sure - I'll wait to see what @kilograham says...
(but if your supposition is correct, we'll still need to change "Alias" to "alias")
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looks like these might have been a copy&paste typo?