Skip to content

Report table/column descriptions in hover documentation #157

@jamietanna

Description

@jamietanna

Is your feature request related to a problem? Please describe.

I have currently documented my database schema with comments above the table description, and alongside each column, i.e.:

Details
-- renovate contains all dependencies that Renovate has been able to discover
-- about a given repository.
--
-- This may be retrieved through `renovate-graph` or via steps described in
-- https://gitlab.com/tanna.dev/dependency-management-data/-/issues/370
--
-- This is one of the first-class package Datasources
-- (https://dmd.tanna.dev/concepts/datasource/) that dependency-management-data
-- supports.
CREATE TABLE IF NOT EXISTS renovate (
  -- what platform hosts the source code that this Renovate data was produced
  -- for? i.e. `github`, `gitlab`, `gitea`, etc
  --
  -- See also: https://dmd.tanna.dev/concepts/repo-key/#platform
  platform TEXT NOT NULL,

However, these comments aren't shown.

Describe the solution you'd like

When using the LSP hover menu to get documentation on a symbol such as the platform field, or the renovate table, it would be useful to see the comments associated.

Describe alternatives you've considered

Additional context

Could this be a non-standard practice, perhaps?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions