PEAR Forum :: PHP Extension and Application Repository

PEAR Forum Forum Index
 FAQFAQ   SearchSearch   MemberlistMemberlist   RegisterRegister   ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 
Adding examples

 
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    PEAR Forum Forum Index -> PEAR FAQ's
View previous topic :: View next topic  
Author Message
primeminister
Site Admin


Joined: 16 Apr 2006
Posts: 95
Location: Netherlands

PostPosted: Tue Apr 18, 2006 11:52 am    Post subject: Adding examples Reply with quote

Am I expected to add examples and/or test files to my package and where to store them?

Last edited by primeminister on Tue Apr 18, 2006 12:13 pm; edited 1 time in total
Back to top
View user's profile Send private message Send e-mail
primeminister
Site Admin


Joined: 16 Apr 2006
Posts: 95
Location: Netherlands

PostPosted: Tue Apr 18, 2006 11:52 am    Post subject: Reply with quote

Examples are a good idea, especially when your class has a complex API. But examples are only a part of a documentation. Don't create examples instead of a documentation. You should store the documentation and the examples in a sub directory 'docs' of the package directory.

Test scripts are recommended when your class has to be compiled, requires special extentions/programs or needs correctly installed additional files (i.e. templates, graphics). Store them in sub directory called 'tests'.
Back to top
View user's profile Send private message Send e-mail
Display posts from previous:   
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    PEAR Forum Forum Index -> PEAR FAQ's All times are GMT + 2 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum



PEAR Forum topic RSS feed 
Powered by phpBB © 2001, 2005 phpBB Group

Provided by Ministry of Web developement