[racket] Scribblings @defproc for typed/racket

For most functions, I don't think it should be documented differently.
 (All ...) is a good point, but it's something we should fix for
functions with plain old contracts as well.

On Tue, Feb 28, 2012 at 3:16 PM, Jay McCarthy <jay.mccarthy at gmail.com> wrote:
> Sam,
>
> Is there a reason you think there should not be Scribble forms for
> typed code/APIs? I think it would be good to communicate its
> typed-ness and have support for things like For Alls, (How are you
> going to communicate for-all-ness with pretend contracts?)
>
> Jay
>
> On 2/27/12, Ray Racine <ray.racine at gmail.com> wrote:
>> @defthing works ok aswll.
>>
>> @defthing[AttributeName (U 'All 'SenderId 'SentTimestamp
>>                            'ApproximateReceiveCount
>>    'ApproximateFirstReceiveTimestamp)]{
>> A define-type of an enumeration of allowable code values ...
>> }
>>
>>
>> On Mon, Feb 27, 2012 at 2:39 PM, Sam Tobin-Hochstadt
>> <samth at ccs.neu.edu>wrote:
>>
>>> On Mon, Feb 27, 2012 at 2:25 PM, Ray Racine <ray.racine at gmail.com> wrote:
>>> > In the vein of scribblings for various typed/racket idioms.
>>> >
>>> > How would you scribble a define-type.
>>> > e.g.
>>> >
>>> > (define-type AttributeReq (U 'All 'SenderId 'SentTimestamp
>>> > 'ApproximateReceiveCount 'ApproximateFirstReceiveTimestamp))
>>>
>>> Something like this:
>>>
>>> @defidform[AttributeReg]{The type of possible attribute requests.
>>> Includes @racket['All], @racket['SenderId], and other stuff.}
>>>
>>>
>>> --
>>> sam th
>>> samth at ccs.neu.edu
>>>
>>
>
>
> --
> Jay McCarthy <jay at cs.byu.edu>
> Assistant Professor / Brigham Young University
> http://faculty.cs.byu.edu/~jay
>
> "The glory of God is Intelligence" - D&C 93



-- 
sam th
samth at ccs.neu.edu