lean-ja / lean-ja/lean-by-example

`import Module` の `Module` に hover したときに docstring を見せる

Open
#2,584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Zulipで質問すべき
Dominant language
Lean
Stars
188
Forks
15
Avg merge
9h 8m
Merged PRs (30d)
6

Description

module docstring があるが、docgen でしか使われていないのだろうか?

せっかくなので、import ModuleModule に hover したときに module docstring を見せるのはどうか?

クリックする手間が1回減るだけだが、便利ではないかと思う。少なくとも私はほしい。

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

The issue proposes showing a module docstring when hovering over Module in import Module, but names no files, tests, or implementation entry point. First determine whether this repository contains the relevant hover behavior or whether the change belongs in Lean tooling. Done means the module docstring is displayed on that hover without requiring a click.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.