update generated_by comment with code #538
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -138,7 +142,7 @@ function appendGeneratedComment( | |||
| return prettifyMarkdown( | |||
| `<!-- genaiscript ${severity} ${code || ""} --> | |||
| ${message} | |||
| ${generatedByFooter(script, info)}` | |||
| ${generatedByFooter(script, info, code)}` | |||
There was a problem hiding this comment.
The change in the function call generatedByFooter(script, info, code) seems to be significant, but there is no accompanying test change. Please ensure this change is covered by tests. 🧪
generated by pr-review-commit(missing_test)
| @@ -138,7 +142,7 @@ function appendGeneratedComment( | |||
| return prettifyMarkdown( | |||
| `<!-- genaiscript ${severity} ${code || ""} --> | |||
| ${message} | |||
| ${generatedByFooter(script, info)}` | |||
| ${generatedByFooter(script, info, code)}` | |||
There was a problem hiding this comment.
The function call to generatedByFooter in appendGeneratedComment now includes an extra argument code. Please ensure that this change doesn't affect other parts of the code where appendGeneratedComment is used. 🧐
generated by pr-review-commit
func_call_change
| info: GithubConnectionInfo, | ||
| code?: string | ||
| ) { | ||
| return `\n\n> generated by ${link(script.id, info.runUrl)}${code ? ` \`${code}\` ` : ""}\n\n` |
There was a problem hiding this comment.
The string formatting in the return statement of generatedByFooter function seems a bit complex. Consider simplifying it or breaking it down for better readability. 📖
generated by pr-review-commit
code_formatting
| info: GithubConnectionInfo, | ||
| code?: string | ||
| ) { | ||
| return `\n\n> generated by ${link(script.id, info.runUrl)}${code ? ` \`${code}\` ` : ""}\n\n` |
There was a problem hiding this comment.
The new parameter code in the function generatedByFooter is missing a documentation comment. It's important to document all parameters to improve code readability and maintainability. 😊
generated by pr-review-commit
missing_param_doc
| info: GithubConnectionInfo, | ||
| code?: string | ||
| ) { | ||
| return `\n\n> generated by ${link(script.id, info.runUrl)}${code ? ` \`${code}\` ` : ""}\n\n` |
There was a problem hiding this comment.
There is a missing whitespace in the string concatenation. It should be ${code ? `${code}` : " "} to ensure proper formatting. 🧐
generated by pr-review-commit
missing_whitespace
| @@ -138,7 +142,7 @@ function appendGeneratedComment( | |||
| return prettifyMarkdown( | |||
| `<!-- genaiscript ${severity} ${code || ""} --> | |||
| ${message} | |||
| ${generatedByFooter(script, info)}` | |||
| ${generatedByFooter(script, info, code)}` | |||
There was a problem hiding this comment.
The function appendGeneratedComment is missing the new parameter code when calling generatedByFooter. Please make sure to pass all required parameters to avoid unexpected behavior. 😇
generated by pr-review-commit
missing_param
No description provided.