Document `WNConfig` - Githubissues

xmonad / xmonad-contrib

Contributed modules for xmonad

https://xmonad.org

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

584 stars 274 forks source link

Document `WNConfig` #749

Closed geekosaur closed 2 years ago

geekosaur commented 2 years ago

Description

configurableNavigation in XMonad.Layout.WindowNavigation uses an opaque type WNConfig and provides three undocumented functions to create WNConfig values. Provide some documentation for them, so it at least makes some kind of sense.

Closes #748.

Checklist

[x] I've read CONTRIBUTING.md
[x] I've considered how to best test these changes (property, unit, manually, ...) and concluded: doc change
[n/a] I updated the CHANGES.md file

geekosaur commented 2 years ago

Also document the default value.

geekosaur commented 2 years ago

Also, I'd just put this directly into master because it's just a doc change, but I still don't trust my Haddock markup skills.

geekosaur commented 2 years ago

Uh. @slotThe, this failed an OrgMode test for some reason? I didn't even touch that.

slotThe commented 2 years ago

Lol. Consider it unrelated, I will take a look at the X.P.OrgMode tests tomorrow

slotThe commented 2 years ago

@geekosaur should be fixed by c701a75002bf7f089732a59c23360153d1178e1c