codeant-ai-for-open-source[bot] commented on code in PR #41424:
URL: https://github.com/apache/superset/pull/41424#discussion_r3476426498
##########
superset/commands/report/exceptions.py:
##########
@@ -275,6 +279,11 @@ class ReportScheduleCsvTimeout(CommandException):
message = _("A timeout occurred while generating a csv.")
+class ReportScheduleXlsxTimeout(CommandException):
+ status = 408
+ message = _("A timeout occurred while generating an Excel file.")
Review Comment:
**Suggestion:** Add a concise docstring to this new timeout exception class
to comply with documentation requirements for new classes. [custom_rule]
**Severity Level:** Minor ⚠️
<details>
<summary><b>Why it matters? 🤔 </b></summary>
This is also a newly added Python class and it lacks a docstring. That
directly violates the rule requiring new Python classes to be documented
inline, so the suggestion is valid.
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=26879b4b952e4d3786d10caa92ea4333&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
[](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=26879b4b952e4d3786d10caa92ea4333&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent 🤖 </b></summary>
```mdx
This is a comment left during a code review.
**Path:** superset/commands/report/exceptions.py
**Line:** 282:284
**Comment:**
*Custom Rule: Add a concise docstring to this new timeout exception
class to comply with documentation requirements for new classes.
Validate the correctness of the flagged issue. If correct, How can I resolve
this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask
user if the user wants to fix the rest of the comments as well. if said yes,
then fetch all the comments validate the correctness and implement a minimal fix
```
</details>
<a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41424&comment_hash=aa25cdfa6ab22fb3afac7b904ddad002eb54c85a1fd70ab429315befe90713c0&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41424&comment_hash=aa25cdfa6ab22fb3afac7b904ddad002eb54c85a1fd70ab429315befe90713c0&reaction=dislike'>👎</a>
##########
superset/commands/report/exceptions.py:
##########
@@ -196,6 +196,10 @@ class ReportScheduleCsvFailedError(CommandException):
message = _("Report Schedule execution failed when generating a csv.")
+class ReportScheduleXlsxFailedError(CommandException):
+ message = _("Report Schedule execution failed when generating an Excel
file.")
Review Comment:
**Suggestion:** Add a short class docstring describing the purpose of this
new exception class. [custom_rule]
**Severity Level:** Minor ⚠️
<details>
<summary><b>Why it matters? 🤔 </b></summary>
This is a newly added Python class and it has no docstring immediately under
the class definition. The custom rule requires newly added Python classes to
include docstrings, so the suggestion identifies a real violation.
</details>
[](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=af8a1b031a6b4e88af83bd2c0f281d69&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
[](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=af8a1b031a6b4e88af83bd2c0f281d69&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent 🤖 </b></summary>
```mdx
This is a comment left during a code review.
**Path:** superset/commands/report/exceptions.py
**Line:** 199:200
**Comment:**
*Custom Rule: Add a short class docstring describing the purpose of
this new exception class.
Validate the correctness of the flagged issue. If correct, How can I resolve
this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask
user if the user wants to fix the rest of the comments as well. if said yes,
then fetch all the comments validate the correctness and implement a minimal fix
```
</details>
<a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41424&comment_hash=553ea8cf97280b6c35df738749b3e4ba336fd170a3f806c7ea13315cb54fe79e&reaction=like'>👍</a>
| <a
href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41424&comment_hash=553ea8cf97280b6c35df738749b3e4ba336fd170a3f806c7ea13315cb54fe79e&reaction=dislike'>👎</a>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
