grafana / grafana/jsonnet-language-server

Support providing docs for non-stdlib function/objects

Open
#109 3 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
223
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Currently only stdlib has doc support, it would be nice to have the same feature for user defined libraries.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by tracing the existing standard-library documentation support and how user-defined libraries are discovered, then determine the equivalent entry point for their functions and objects. Done means documentation is available for non-stdlib libraries with coverage for the relevant lookup cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.