leanprover / leanprover/lean4

inherit_doc does not show docs on the declaration itself

Open
#4,204 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P-low
Dominant language
Lean
Stars
9.2k
Forks
990
Avg merge
1d 17h
Merged PRs (30d)
175

Description

Proposal

Add hover support to defs with inherit_doc that forwards the inherited doc + type sig of current def.

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

Start by tracing Lean 4's hover support for declarations and the handling of defs marked with inherit_doc. Confirm how inherited documentation and the current definition's type signature are represented. Done means hovering such a declaration shows both the inherited documentation and the current def's type signature.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.