[racket] How to document a package and access its documentation
On 13/08/13 13:57, Jay McCarthy wrote:
> On Tue, Aug 13, 2013 at 3:47 AM, Lawrence Woodman
> <lwoodman at vlifesystems.com> wrote:
>> On 12/08/13 15:08, Jay McCarthy wrote:
>>> Packages do not have documentation, but collections inside of packages
>>> may have documentation.
>>>
>>> However, if you have a single collection package, then the info file
>>> is for both the package and the collection metadata.
>>
>> In my package I have the following directory structure:
>>
>> . Package root
>> info.rkt Package info.rkt
>> xdgbasedir/ Collection directory
>> xdgbasedir/info.rkt Collection info.rkt
>>
>> In order to move to a single info.rkt should I move the
>> xdgbasedir/info.rkt into the package root, or should I just remove
>> the package info.rkt?
> You would move everything from the xdgbasedir to the root and remove
> the xdgbasedir directory.
>
>> Once I have a single info.rkt, what will the version entry refer to: the
>> package, collection or both?
> Collections do not have version entries, so the version entry would
> refer to the package.
Thanks I got confused because I was thinking of a .plt as being
equivalent to a collection,
this makes sense now.
Lorry
--
vLife Systems Ltd
Registered Office: The Meridian, 4 Copthall House, Station Square,
Coventry, CV1 2FL
Registered in England and Wales No. 06477649
http://vlifesystems.com