Doc fixes in Control.Exception - Libraries - Haskell.org

newer
Re: Proposed ghc-pkg and cabal...

Doc fixes in Control.Exception

older
MonadWriter instance for ListT

Bas van Dijk

1 Mar 2010 1 Mar '10

5:12 p.m.

Hello, I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them. It would be nice if somebody could apply the patch. regards, Bas

Attachments:

doc_fixes_in_Control.Exception.dpatch (application/octet-stream — 27.4 KB)

Reply

Sign in to reply online Use email software

Show replies by date

Thomas Hartman

4 Mar 4 Mar

12:07 a.m.

did this ever get applied? You might want to try the haskell libraries mailing list (cc'd). thomas. 2010/3/1 Bas van Dijk :

Hello,

I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them.

It would be nice if somebody could apply the patch.

regards,

Bas

_______________________________________________ Libraries mailing list Libraries@haskell.org http://www.haskell.org/mailman/listinfo/libraries

Reply

Sign in to reply online Use email software

Ian Lynagh

7 Mar 7 Mar

5:46 p.m.

On Mon, Mar 01, 2010 at 11:12:15PM +0100, Bas van Dijk wrote:

I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them.

I'm not sure about the bit of the patch below. David, Control/Exception.hs contains: -- ** Catching all exceptions -- $catchall [...] {- $catchall It is possible to catch all exceptions, by using the type 'SomeException': but the reference to $catchall in Control/Exception/Base.hs isn't working; in Control-Exception.html $catchall isn't expanded. Is that a bug, or expected behaviour? hunk ./Control/Exception/Base.hs 342 -- -- Note that we have to give a type signature to @e@, or the program -- will not typecheck as the type is ambiguous. While it is possible --- to catch exceptions of any type, see $catchall for an explanation --- of the problems with doing so. +-- to catch exceptions of any type, see the previous section \"Catching all +-- exceptions \" for an explanation of the problems with doing so. -- -- For catching exceptions in pure (non-'IO') expressions, see the -- function 'evaluate'. Thanks Ian

Reply

Sign in to reply online Use email software

David Waern

6:22 p.m.

2010/3/7 Ian Lynagh :

On Mon, Mar 01, 2010 at 11:12:15PM +0100, Bas van Dijk wrote:

...
I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them.

I'm not sure about the bit of the patch below. David, Control/Exception.hs contains:

-- ** Catching all exceptions

-- $catchall

[...]

{- $catchall

It is possible to catch all exceptions, by using the type 'SomeException':

but the reference to $catchall in Control/Exception/Base.hs isn't working; in Control-Exception.html $catchall isn't expanded. Is that a bug, or expected behaviour?

Not exactly sure what you mean, here. The $catchall reference in Control/Exception/Base.hs should not work (if by "work" you mean create some kind of reference to the documentation in Control/Exception.hs). In Control.Exception everything seems fine ($catchall is expanded). Or are you seeing something else? David

Reply

Sign in to reply online Use email software

Ian Lynagh

8 Mar 8 Mar

11:47 a.m.

On Mon, Mar 08, 2010 at 12:22:35AM +0100, David Waern wrote:

2010/3/7 Ian Lynagh :

...
On Mon, Mar 01, 2010 at 11:12:15PM +0100, Bas van Dijk wrote:

...
I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them.

I'm not sure about the bit of the patch below. David, Control/Exception.hs contains:

-- ** Catching all exceptions

-- $catchall

[...]

{- $catchall

It is possible to catch all exceptions, by using the type 'SomeException':

but the reference to $catchall in Control/Exception/Base.hs isn't working; in Control-Exception.html $catchall isn't expanded. Is that a bug, or expected behaviour?

Not exactly sure what you mean, here. The $catchall reference in Control/Exception/Base.hs should not work (if by "work" you mean create some kind of reference to the documentation in Control/Exception.hs).

In Control.Exception everything seems fine ($catchall is expanded). Or are you seeing something else?

No, sounds like it's working as expected. Thanks! Thanks Ian

Reply

Sign in to reply online Use email software

Bas van Dijk

2:09 p.m.

On Mon, Mar 8, 2010 at 5:47 PM, Ian Lynagh wrote:

...
...
but the reference to $catchall in Control/Exception/Base.hs isn't working; in Control-Exception.html $catchall isn't expanded. Is that a bug, or expected behaviour?

Not exactly sure what you mean, here. The $catchall reference in Control/Exception/Base.hs should not work (if by "work" you mean create some kind of reference to the documentation in Control/Exception.hs).

In Control.Exception everything seems fine ($catchall is expanded). Or are you seeing something else?

No, sounds like it's working as expected. Thanks!

There's a reference to $catchall in the documentation of 'catch' which doesn't link to the proper place: http://haskell.org/ghc/docs/latest/html/libraries/base-4.2.0.0/Control-Excep... Bas

Reply

Sign in to reply online Use email software

Bas van Dijk

2:12 p.m.

I just noticed that my patch also changed the following: --- |The thread is awiting to retry an STM transaction, but there are no +-- |The thread is awaiting to retry an STM transaction, but there are no -- other references to any @TVar@s involved, so it can't ever continue. data BlockedIndefinitelyOnSTM = BlockedIndefinitelyOnSTM deriving Typeable hunk ./GHC/IO/Exception.hs 94 However this should obviously not be 'awaiting' but 'waiting'. Should I create a new patch or can you guys fix that? Bas

Reply

Sign in to reply online Use email software

David Waern

2:31 p.m.

2010/3/8 Bas van Dijk :

There's a reference to $catchall in the documentation of 'catch' which doesn't link to the proper place:

That kind of reference is not supported by Haddock, unless I've missed something. David

Reply

Sign in to reply online Use email software

Bas van Dijk

4:23 p.m.

On Mon, Mar 8, 2010 at 8:31 PM, David Waern wrote:

2010/3/8 Bas van Dijk :

...
There's a reference to $catchall in the documentation of 'catch' which doesn't link to the proper place:

That kind of reference is not supported by Haddock, unless I've missed something.

That's why I removed it in the patch and replaced it with a textual reference. regards, Bas

Reply

Sign in to reply online Use email software

Bas van Dijk

5:31 p.m.

I also noticed some dead links to 'BlockedOnDeadMVar' and 'BlockedIndefinitely' in the documentation of 'forkIO': http://haskell.org/ghc/docs/latest/html/libraries/base-4.2.0.0/Control-Concu... I see 'BlockedOnDeadMVar' got renamed to 'BlockedIndefinitelyOnMVar' and 'BlockedIndefinitely' got renamed to 'BlockedIndefinitelyOnSTM'. The attached patch fixes it. regards, Bas

Reply

Sign in to reply online Use email software

Ian Lynagh

13 Mar 13 Mar

4:18 p.m.

On Mon, Mar 08, 2010 at 11:31:30PM +0100, Bas van Dijk wrote:

I also noticed some dead links to 'BlockedOnDeadMVar' and 'BlockedIndefinitely' in the documentation of 'forkIO':

The attached patch fixes it.

Thanks, applied! Thanks Ian

Reply

Sign in to reply online Use email software

Ian Lynagh

4:18 p.m.

On Mon, Mar 01, 2010 at 11:12:15PM +0100, Bas van Dijk wrote:

I noticed some minor errors in the documentation of Control.Exception. The attached patch fixes them.

It would be nice if somebody could apply the patch.

Thanks, applied! Thanks Ian

Reply

Sign in to reply online Use email software

5549

Age (days ago)

5561

Last active (days ago)

Download

11 comments

4 participants

tags

participants (4)

Bas van Dijk
David Waern
Ian Lynagh
Thomas Hartman