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

MkSocket could use some Haddock documentation #148

Closed
Rufflewind opened this issue Oct 23, 2014 · 3 comments
Closed

MkSocket could use some Haddock documentation #148

Rufflewind opened this issue Oct 23, 2014 · 3 comments

Comments

@Rufflewind
Copy link
Member

There isn't any Haddock documentation for MkSocket, but the source code is commented:

  = MkSocket
            CInt                 -- File Descriptor
            Family
            SocketType
            ProtocolNumber       -- Protocol Number
            (MVar SocketStatus)  -- Status Flag

It would be better if these were converted to Haddock comments instead:

  = MkSocket
            CInt                 -- ^ File Descriptor
            Family
            SocketType
            ProtocolNumber       -- ^ Protocol Number
            (MVar SocketStatus)  -- ^ Status Flag
@tibbe
Copy link
Member

tibbe commented Oct 23, 2014

Agreed. Mind whipping together a pull request?

@Rufflewind
Copy link
Member Author

Turns out that Haddock doesn't support documenting fields unless it's in the record syntax, so I just wrote them outside instead.

@WillSewell
Copy link

Better to close this?

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

No branches or pull requests

3 participants