Skip to content

Fix empty descriptions in PR and commit issue queries#283

Open
shawnz wants to merge 1 commit intoDeepSourceCorp:masterfrom
shawnz:shawnz/issue-descriptions-pr-commit
Open

Fix empty descriptions in PR and commit issue queries#283
shawnz wants to merge 1 commit intoDeepSourceCorp:masterfrom
shawnz:shawnz/issue-descriptions-pr-commit

Conversation

@shawnz
Copy link

@shawnz shawnz commented Mar 21, 2026

This fixes #282.

The PR and commit queries read the explanation field from the AnalysisIssue type, which the server returns as empty. Use issue { shortDescription } instead, matching the pattern used by the default-branch query.

With this change, the seemingly unused explanation field can be deprecated in the GraphQL API. An alternative would be to start populating it with the issue description, in which case this PR would not be necessary.

The PR and commit queries read the `explanation` field from the
AnalysisIssue type, which the server returns as empty. Use
`issue { shortDescription }` instead, matching the pattern used
by the default-branch query.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@deepsource-io
Copy link

deepsource-io bot commented Mar 21, 2026

DeepSource Code Review

We reviewed changes in d444ee5...6de42f7 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
Go Mar 21, 2026 12:39a.m. Review ↗
Secrets Mar 21, 2026 12:39a.m. Review ↗
Test coverage Mar 21, 2026 12:39a.m. Review ↗

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

issues --pr and --commit always return empty descriptions

1 participant