search

xmonad / xmonad-contrib

Contributed modules for xmonad
https://xmonad.org
BSD 3-Clause "New" or "Revised" License
589 stars 274 forks source link

Add `Description` string to modules #592

Closed slotThe closed 3 years ago

slotThe commented 3 years ago

Problem Description

Right now, only two modules have a Haddock-visible Description set: https://xmonad.github.io/xmonad-docs/

It would be nice to change this before 0.17 hits, in order to aid discoverability. Most of the information needed is already available in appropriately concise form in X.D.Extending and would only need to be copied over.

At the same time, it would be nice to add a template for new modules to CONTRIBUTING that includes this and perhaps drops some fields that no one ever looks at anymore (namely, Portability and Stability). I would suggest something like 

--------------------------------------------------------------------------------
-- |
-- Module      :  XMonad.Module.Name
-- Description :  Short one-line description
-- Copyright   :  (c) YEAR  person <email>
-- License     :  BSD3-style (see LICENSE)
--
-- Maintainer  :  person
--
-- Summary of the module 
--------------------------------------------------------------------------------