[Examples]: Write examples for the docs

[apoorvcodes]

Describe the solution you'd like
So basically docgen is now configured to read @example tags so we will like to have some examples in the docs

Describe alternatives you've considered
An alternative can be ignoring them and having em on the guide but it wouldnt be suited tbh

[apoorvcodes]

Any volunteers for the feature request @booleanrecep @megatank58 @savioxavier @scientific-dev

[megatank58]

I don't think it's good to add @example tag for every documentation, it will just add more lines, instead we can add comments only for necessary functions which are vague in explanation or which have too many configuration option

[booleanrecep]

Any volunteers for the feature request @booleanrecep @megatank58 @savioxavier @scientific-dev

@apoorvcodes I am pretty intrested. For my current beginner knowledge It would be difficult for me to decide with what feature to deal. If you just give me a shortly discribed task I will happily get involved to code it

[apoorvcodes]

Oh okay thanks for your interest @booleanrecep, I'll soon explain you the task

[apoorvcodes]

@booleanrecep @megatank58 @savioxavier This is on hold cos m working on looking to squeeze out some more performance through hash table

[apoorvcodes]

I don't think it's good to add @example tag for every documentation, it will just add more lines, instead we can add comments only for necessary functions which are vague in explanation or which have too many configuration option

I kinda agree

[apoorvcodes]

With #33 pr we will have new hash implementation which makes us like 10x faster at scale, and I'll be doing the comments