`X.D.Extending`: Remove module list

xmonad / xmonad-contrib

Contributed modules for xmonad

https://xmonad.org

BSD 3-Clause "New" or "Revised" License

589 stars 274 forks source link

`X.D.Extending`: Remove module list #620

Closed TheMC47 closed 3 years ago

TheMC47 commented 3 years ago

Description

As of 38c11c1e3cfa1b91d9af796872e3d011895b4d50, all modules now include a Description string that can be rendered using Haddock. This makes the list in XMonad.Doc.Extending redundant.

The module still needs a bit of reworks, I'll take care of the DynamicLog/StatusBar bits in #613

Checklist

[x] I've read CONTRIBUTING.md
[x] I've considered how to best test these changes (Haddock). Yep they're gone alright
(N/A) I updated the CHANGES.md file
[X] I updated the XMonad.Doc.Extending file (you bet I did)

liskin commented 3 years ago

We can now drop the mention of X.D.Extending from https://github.com/xmonad/xmonad-contrib/blob/master/.github/PULL_REQUEST_TEMPLATE.md, I think. We just need to keep checking that new modules set Description.

slotThe commented 3 years ago

We just need to keep checking that new modules set Description.

I suppose the easiest thing would be do change the "I have updated X.D.Extending" nit into an I have added aDescription` field into the module header" nit.

Alternatively we could add a template for this in CONTRIBUTING (though I suppose explaining how to write contrib modules does not really fit into core's CONTRIBUTING...)

liskin commented 3 years ago

I suppose the easiest thing would be do change the "I have updated X.D.Extending" nit into an I have added aDescription` field into the module header" nit.

That seems a bit unnecessarily pedantic. :-) I'd hope most people just copypaste the module header from somewhere and this won't in fact be a problem at all.