Re: Services_Twitter documentation

Hi David, > Documentation is very important indeed, what about setting up a > documentation plan and working on it in the next days ? > I'm not sure it's a good idea to document each twitter API method That's not the scope of peardoc - we have phpdocumentor autogenerated api docs for that. The manual itself shall contain overviews, examples and how-to guides - just as you outlined. > , as > it would duplicate the twitter API docs, but the plan could be > something like: > > 1. Introduction/Quick start > > 2. Configuration > This would deal with instantiation options, setting up a http proxy > etc... > > 3. Authentication / Security > 3.1 Basic Auth > 3.2 OAuth > 3.3 Using SSL > > 4. Making API calls > This section would explain in details how to make API calls, how to > deal with required and optional parameters and how to manipulate the > returned results. > > 5. Exceptions > This section would tell the user how to handle exceptions with > Services_Twitter. > > 6. Examples > Simple and advanced examples of what can be done with the package. -- Regards/Mit freundlichen Grüßen Christian Weiske -= Geeking around in the name of science since 1982 =-

Attachment: [application/pgp-signature] signature.asc