SQL comments not showing in interface godocs

[sbres]

Version

1.11.0

What happened?

When the go code is generated, the docstrings are written on the Querier interface methods.

This is annoying because the ide will check the docstring of the interface and not the one from the implementation.

Relevant log output

No response

Database schema

No response

SQL queries

No response

Configuration

No response

Playground URL

No response

What operating system are you using?

macOS

What database engines are you using?

PostgreSQL

What type of code are you generating?

Go

[kyleconroy]

Can you please include a full reproduction of the issue?

[sbres]

I've created a repo with an example:
https://github.com/sbres/sqlc_example

The query code:

-- name: CreateNewUser :one
-- CreateNewUser will create a new user
INSERT INTO users ("name", "email", "password")
VALUES (
    $1, $2, $3
)
RETURNING id
;

The sqlc.yaml file config

version: "1"
packages:
  - name: "sqlc"
    path: "sqlc"
    queries: "query/"
    schema: "migration/"
    engine: "postgresql"
    emit_empty_slices: true
    emit_json_tags: true
    emit_interface: true

The generated method with the docstring:

// CheckUserExist will check if the user exist, retuns true if the exists
func (q *Queries) CheckUserExist(ctx context.Context, email string) (bool, error) {
	row := q.db.QueryRowContext(ctx, checkUserExist, email)
	var column_1 bool
	err := row.Scan(&column_1)
	return column_1, err
}

The interface without the doctring:

type Querier interface {
	CheckUserExist(ctx context.Context, email string) (bool, error)
	CreateNewUser(ctx context.Context, arg CreateNewUserParams) (int32, error)
}

The "issue" comes when using an IDE.

When I use the struct the IDE is able to find the docsting

func doSomethingStruct(q sqlc.Queries, ctx context.Context) {
	q.CheckUserExist(ctx, "email string")
}

But when I use the interface, the IDE can't find a docstring

func doSomethingInterface(q sqlc.Querier, ctx context.Context) {
	q.CheckUserExist(ctx, "email string")
}

This is maybe a feature more than a bug that could be added to improve the usability :)

[sbres]

Solved on #1458 🎉