Idris2 icon indicating copy to clipboard operation
Idris2 copied to clipboard

Show module docstring for namespace indexes

Open scarf005 opened this issue 2 years ago • 0 comments

  • [x] I have read CONTRIBUTING.md.
  • [x] I have checked that there is no existing PR/issue about my proposal.

Summary

Before After
before after

Motivation

Hoogle Idris2
hoogle idris

search result on hoogle shows module summary, which is very helpful for beginners.

The proposal

As shown in summary, provide brief summary for each modules.

Technical implementation

  1. use module docstring
||| Types and functions for reasoning about time.
module System.Clock

will output Types and functions for reasoning about time.

  1. add it to resulting html.
  2. truncate if it's too long.
  3. use flexbox and justify-content: space-around to make it pretty.

scarf005 avatar Jul 12 '23 01:07 scarf005