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

Fix haddocks of createPipe #330

Merged
merged 1 commit into from
Nov 24, 2024
Merged

Fix haddocks of createPipe #330

merged 1 commit into from
Nov 24, 2024

Conversation

sol
Copy link
Member

@sol sol commented Nov 22, 2024

No description provided.

@sol sol force-pushed the fix-haddocks branch 3 times, most recently from ed35935 to 2af51cd Compare November 22, 2024 23:12
Comment on lines 210 to 212
-- #if defined (__IO_MANAGER_WINIO__)
-- return () <!> (do
-- associateHandle' =<< handleToHANDLE <handle>)
-- #if defined(__IO_MANAGER_WINIO__)
-- return () `<!>` do
-- associateHandle' `=<<` handleToHANDLE readEnd
Copy link
Member

Choose a reason for hiding this comment

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

Would you mind posting a before and after screenshot? I'm confused what the backticks are for (escaping the <?).

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm confused what the backticks are for (escaping the <?).

They hyperlink the identifier. The main reason I used them here is that otherwise < would need to be escaped as \<. That they also hyperlink is a nice by product.

Would you mind posting a before and after screenshot?

Sorry, I'm away from my computer right now.

Please look at Hackage for how it is currently rendered. You will immediately see that it is broken. This PR fixes this. You can verify this with cabal haddock.

Copy link
Member

Choose a reason for hiding this comment

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

OK, sure. I don't think we need to hyperlink =<<, and the link didn't appear on <!> anyway, so I converted it to escaping.

Before

screenshot

After

screenshot2

@tomjaguarpaw tomjaguarpaw merged commit 166971f into haskell:master Nov 24, 2024
41 checks passed
@tomjaguarpaw
Copy link
Member

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.

2 participants