Just try to match the surrounding style and get the RST formatting right.
> On May 24, 2014, at 8:47 AM, Florian Oswald <[email protected]> wrote: > > alright cool will do! > is there anything special i need to keep in mind (format, conventions etc) or > i just add this below whatever I find in the curren help? > cheers > > >> On 24 May 2014 13:44, Stefan Karpinski <[email protected]> wrote: >> We definitely need more examples in help. This is very tedious to add but >> fortunately highly parellelizable – if you encounter a function that >> confuses you and needs an example, you can easily add one via a pull request. >> >>> On May 24, 2014, at 7:33 AM, Florian Oswald <[email protected]> >>> wrote: >>> >>> Hi all, >>> >>> I just spent 20 minutes trying to figure out why this is not working: >>> >>> A =[1,2,3] >>> repeat(A,2,1) >>> >>> After looking at help(repeat), I (slightly) improved my attempt to >>> >>> repeat(A,[2,2,2],[1,1,1]) >>> >>> but still no luck. Now this may be completely my shortcoming of a proper >>> understanding of the Julia language (I reckon at some point in the manual >>> the user is reminded that "if a function is defined with keywords, you >>> actually have to provide them"), but a simple one-line example in >>> help(repeat) of the kind >>> >>> repeat(A,inner=[2,2,2],outer=[1,1,1]) >>> >>> would have sorted me out in 2 seconds. I would encourage to have an example >>> in every help(), wherever possible. It could just be (part of) the unit >>> test. Coming from R, the examples in the help files are extremely helpful. >>> >>> >>> >
