Message Boards Message Boards

2
|
4697 Views
|
1 Reply
|
4 Total Likes
View groups...
Share
Share this post:

Documentation on ... documentation

I was looking up details on how to format "::usage" statements in packages, and I realized the documentation on documentation is scarce... or I couldn't easily find it.

Is there any comprehensive resources on developing documentation for packages?

Also, is the "Tutorial Collection" ever coming back? I love the PDF's and would love updated versions. I know most/all the information is in the documentation, but it's harder to follow when it's scattered across so many help pages.
POSTED BY: Eric Smith
1 Reply
Sort By:

More direct question: How do I use "usage"? In other words, I'd like to wrap the text to multiple lines but adding a new line makes the "tooltip" in the front end separates it. Like this:

Code:

wallConfig::usage = "wallConfig[b_,s_] 
    Grabs the relevant wall details for the specified branch (b) and section (s)
    Requirements: \"importEverything\" must be executed first"

"Tooltip" (ignore the space in "executed")

enter image description here
POSTED BY: Eric Smith
Reply to this discussion
Community posts can be styled and formatted using the Markdown syntax.
Tag limit exceeded
Note: Only the first five people you tag will receive an email notification; the other tagged names will appear as links to their profiles.
Reply Preview
Attachments
Remove
or Discard

Group Abstract Group Abstract