[racket-dev] Attempted clarification for planet2 docs

From: John Clements (clements at brinckerhoff.org)
Date: Wed Jan 2 14:30:56 EST 2013

As I was trying to assembly my first planet2 package, I found myself wondering how exactly to 'require' modules associated with planet2 packages. My initial assumption (require them like any other collection containing modules) turned out to be correct, but there was a period when I doubted this, and I think it should be documented. 

Below is a proposed doc change; I'll commit it if you like it, or abandon it if not. I'm including the (git format-patch) text and also attaching it as a file.


From d3f72c47820effb240532c518378dc9709d69600 Mon Sep 17 00:00:00 2001
From: John Clements <clements at racket-lang.org>
Date: Tue, 1 Jan 2013 10:40:40 -0800
Subject: [PATCH] added docs on requiring planet2 modules

 collects/planet2/scribblings/planet2.scrbl |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/collects/planet2/scribblings/planet2.scrbl b/collects/planet2/scribblings/planet2.scrbl
index e9e565a..81d6e58 100644
--- a/collects/planet2/scribblings/planet2.scrbl
+++ b/collects/planet2/scribblings/planet2.scrbl
@@ -200,6 +200,20 @@ imply a change in the @tech{checksum}.
 @section{Using Packages}
+Modules installed using planet2 may be @tech{require}d like any other
+modules. For instance, if the package @pkgname{recipes} contains
+the module file  @filepath{vegan/fruitsalad.rkt}, then package users
+who have this package installed may evaluate
+ at racketblock[(require vegan/fruitsalad)]
+...to require this module.
+@; ----------------------------------------
+ at section{Managing Packages}
 The Racket package manager has two user interfaces: a command line @exec{raco}
 sub-command and a library. They have the exact same capabilities, as
 the command line interface invokes the library functions and
-- (Apple Git-26)

-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-added-docs-on-requiring-planet2-modules.patch
Type: application/octet-stream
Size: 1303 bytes
Desc: not available
URL: <http://lists.racket-lang.org/dev/archive/attachments/20130102/f5780768/attachment.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4370 bytes
Desc: not available
URL: <http://lists.racket-lang.org/dev/archive/attachments/20130102/f5780768/attachment.p7s>

Posted on the dev mailing list.