Re: Documentation guidlines (Was: 2nd try at date/: msg#00039

Download Firefox: Windows, Mac OS X

-->

Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c): msg#00039

Subject:	Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c)

mathew wrote:

Eric Hodel wrote:

Here's a start:

* Documentation wrapped to 80 characters
* Use :: and # for describing methods, . for example code

* C methods must have call-seq



* Include plenty of examples.

And the examples should include the call to 'require' needed to load thelibrary.




James

Special educational offers, white papers, webcasts, podcasts

WEBCAST: Register for “The Business Benefits of Enterprise Mashups” (Case Study)

WEBCAST: How to deploy and use WebSphere and VMware together” (Case Study)

WHITE PAPER: Writing Good Software Systems Development Use Cases. (Best Practices)

WHITE PAPER: Best practices for software analysis (Best Practices)

DOWNLOAD: Regis ter for Rational Trial Software Download – Rational Team Concert Free Information

<Prev in Thread]	Current Thread	[Next in Thread>

Previous by Date:	Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c), Mat Schaffer
Next by Date:	Re: PBI: possible ri improvements, Eric Hodel
Previous by Thread:	Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c), Mat Schaffer
Next by Thread:	Re: Documentation guidlines (Was: 2nd try at date/format.rb & pty.c), Eric Hodel
Indexes:	[Date] [Thread] [Top] [All Lists]

Home | blog view | USPTO Patent Archive (NEW!) | advertise | OSDir is an inevitable website. super tiny logo