📝 Add docstrings to tick_draw
#28
Merged
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
Docstrings generation was requested by @WSQS. * #27 (comment) The following files were modified: * `main.cpp`
Author
|
Important Review skippedCodeRabbit bot authored PR detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Contributor
|
Here's the code health analysis summary for commits Analysis Summary
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| * If the shader source is modified, the pipeline's vertex shader source is updated. | ||
| * | ||
| * @return SDL_AppResult SDL_APP_CONTINUE to indicate the application should continue running. | ||
| */ |
There was a problem hiding this comment.
warning: method 'tick' can be made static [readability-convert-member-functions-to-static]
Suggested change
| */ | |
| static SDL_AppResult tick() |
| * If no swapchain texture is available the function still submits the command buffer and continues. | ||
| * | ||
| * @return SDL_AppResult `SDL_APP_CONTINUE` to continue the application main loop. | ||
| */ |
There was a problem hiding this comment.
warning: method 'draw' can be made static [readability-convert-member-functions-to-static]
Suggested change
| */ | |
| static SDL_AppResult draw() |
|
clang-tidy review says "All clean, LGTM! 👍" |
WSQS
added a commit
that referenced
this pull request
Nov 15, 2025
* feat: split tick function and draw function * 📝 Add docstrings to `tick_draw` (#28) * 📝 Add docstrings to `tick_draw` Docstrings generation was requested by @WSQS. * #27 (comment) The following files were modified: * `main.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 7f55a49 according to the output from ClangFormat. Details: #28 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
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.
Docstrings generation was requested by @WSQS.
The following files were modified:
main.cppℹ️ Note