Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report table/column descriptions in hover documentation #157

Open
jamietanna opened this issue May 16, 2024 · 0 comments
Open

Report table/column descriptions in hover documentation #157

jamietanna opened this issue May 16, 2024 · 0 comments

Comments

@jamietanna
Copy link

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.:

-- 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant