CallStack naming

[Simon Peyton Jones]

|  In that case we'll probably want to move the CallStack section of the
|  user guide elsewhere, right now it's a subsection of ImplicitParams.

Yes!

|  True, so perhaps a single mention of the implicit parameter,
|  explaining that it's not part of the API and that using it is
|  *explicitly unsupported*, i.e. we may change the implementation later.

Yes!


|  - WithCallStack
|  - HasCallStack
|  - GetsCallStack

I vote for HasCallStack.

Simon

|  -----Original Message-----
|  From: ghc-devs [mailto:ghc-devs-bounces at haskell.org] On Behalf Of Eric
|  Seidel
|  Sent: 21 January 2016 16:15
|  To: ghc-devs at haskell.org
|  Subject: Re: CallStack naming
|  
|  On Thu, Jan 21, 2016, at 04:07, Simon Peyton Jones wrote:
|  > Well, in the short term, let's
|  >  * bikeshed about names
|  
|  Ok, I don't like ICallStack :) It sounds like a C# interface, which,
|  while technically sort of accurate, is very misleading since users
|  will never write an instance. I'd prefer something a bit more
|  descriptive, like
|  
|  - WithCallStack
|  - HasCallStack
|  - GetsCallStack
|  
|  (in no particular order)
|  
|  >  * write down the user-visible API, ensuring that it makes
|  >    no mention of implicit parameters (provide setCallStack)
|  >
|  > Then we can implement the API differently later if we so desire.
|  
|  In that case we'll probably want to move the CallStack section of the
|  user guide elsewhere, right now it's a subsection of ImplicitParams.
|  
|  > The main disadvantage is that the abstraction is leaky.  We can't
|  > *prevent* users from seeing and using the implicit parameter.
|  
|  True, so perhaps a single mention of the implicit parameter,
|  explaining that it's not part of the API and that using it is
|  *explicitly unsupported*, i.e. we may change the implementation later.
|  
|  > Does that sound like a plan.  Might you do it Eric?  The urgency is
|  > just to get 8.0 out with an API that we like
|  
|  Sure, I'll try to have a patch out later today.
|  _______________________________________________
|  ghc-devs mailing list
|  ghc-devs at haskell.org
|  https://na01.safelinks.protection.outlook.com/?url=http%3a%2f%2fmail.h
|  askell.org%2fcgi-bin%2fmailman%2flistinfo%2fghc-
|  devs&data=01%7c01%7csimonpj%40064d.mgd.microsoft.com%7c520a5cb5bf08467
|  e9bd908d3227dfb21%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=Bv%2fkj
|  FszUZpmWXmU0AcnrumJU9XfUU5v%2fdMCKUP4dGY%3d