The second round of updates to X.D.Extending, so it's not so old and crufty anymore. Still not completely done with the module, but getting there!
Commit Summary
X.D.Extending: Add links to headings
This is more ergonomic to use than the old-style headings; plus, the
generated Haddock is easier to read than just stating
"XMonad.Doc.Extending".
X.D.Extending: Update hooks
Refer to X.H.StatusBar whenever possible at the start.
Fix some small typos throughout the module.
X.D.Extending: Rewrite keyDel
Nowadays, removing keys is mostly done via removeKeys and removeKeysP,
so the documentation should reflect that fact. This part is less
step-by-step instructive than the section about adding keys, but read in
succession it presents a way to deepen the newly acquired knowledge.
X.D.Extending: Remove keyAddDel and logHook
$keyAddDel can just be a side note in $keyDel, it does not need its
own section.
$logHook is covered in more detail in the tutorial and does not serve
a real purpose anymore. One could rewrite it to be more in-depth
about the inner workings of X.H.StatusBar, but for the time removing
it seems like the best option.
Description
Closes: https://github.com/xmonad/xmonad-contrib/issues/645
The second round of updates to X.D.Extending, so it's not so old and crufty anymore. Still not completely done with the module, but getting there!
Commit Summary
X.D.Extending: Add links to headings
This is more ergonomic to use than the old-style headings; plus, the generated Haddock is easier to read than just stating "XMonad.Doc.Extending".
X.D.Extending: Update hooks
X.D.Extending: Rewrite keyDel
Nowadays, removing keys is mostly done via removeKeys and removeKeysP, so the documentation should reflect that fact. This part is less step-by-step instructive than the section about adding keys, but read in succession it presents a way to deepen the newly acquired knowledge.
X.D.Extending: Remove keyAddDel and logHook
$keyAddDel can just be a side note in $keyDel, it does not need its own section.
$logHook is covered in more detail in the tutorial and does not serve a real purpose anymore. One could rewrite it to be more in-depth about the inner workings of X.H.StatusBar, but for the time removing it seems like the best option.
Checklist
[x] I've read CONTRIBUTING.md
[x] I've considered how to best test these changes (property, unit, manually, ...) and concluded: it's docs
[n/a] I updated the
CHANGES.mdfileDon't think this is necessary (at least not until this has seen a full rewrite)