Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Don't link to re-exports from XMonad.Config.Prime #915

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

sol
Copy link
Contributor

@sol sol commented Dec 18, 2024

No description provided.

Copy link
Contributor

@geekosaur geekosaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏽

@liskin
Copy link
Member

liskin commented Dec 18, 2024

I vaguely remember trying this a couple years ago but whatever version of Haddock we were using back then didn't seem to change its behaviour. Does this actually work now? That would be awesome! (But we might need to bump xmonad-docs to a newer version of ghc/haddock)

@sol
Copy link
Contributor Author

sol commented Dec 19, 2024

Does this actually work now? That would be awesome! (But we might need to bump xmonad-docs to a newer version of ghc/haddock)

I didn't actually try. I just did the edit quickly on GitHub from my mobile device.

@slotThe
Copy link
Member

slotThe commented Dec 19, 2024

From a cursory local test, seems like this doesn't work :(

@sol sol closed this Dec 19, 2024
@sol sol reopened this Dec 19, 2024
@sol
Copy link
Contributor Author

sol commented Dec 19, 2024

{-# OPTIONS_HADDOCK hide #-} does the trick. This has the disadvantage that we lose the documentation of XMonad.Config.Prime, but given that it is deprecated I hope this is an easy compromise.

Copy link
Member

@slotThe slotThe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{-# OPTIONS_HADDOCK hide #-} does the trick.

Seems to work 👍

This has the disadvantage that we lose the documentation of XMonad.Config.Prime, but given that it is deprecated I hope this is an easy compromise.

Indeed, a small price to pay

@sol
Copy link
Contributor Author

sol commented Dec 20, 2024

OK, great, from my side this is ready to merge.

@sol
Copy link
Contributor Author

sol commented Dec 21, 2024

Is there anything else to discuss here? If not, can somebody click the merge button?

@slotThe slotThe merged commit d9e54c1 into xmonad:master Dec 22, 2024
20 checks passed
@slotThe
Copy link
Member

slotThe commented Dec 22, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants