luakit / luakit/luakit

Print link to relevant luakit documentation in error log

Open
#345 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
Lua
Stars
2.3k
Forks
254
PR merge metrics
No merged PRs in 30d

Description

If an API is used incorrectly, it'd be nice to print a link to the documentation as well, as well as a parameter name if possible, not just a number.

Contributor guide

Open the contributing guide

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 file, test, or specific API is identified in the issue. Start by locating luakit's API error-logging entry points and the documentation for the affected APIs; done means relevant errors include a documentation link and, where available, the parameter name.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.