caMicroscope icon indicating copy to clipboard operation
caMicroscope copied to clipboard

Published 20 hours ago • verified publisher icon camicroscope

Improved In-Code Documentation

Open birm opened this issue 4 years ago • 6 comments

Some things are pretty difficult to read, and could likely use a bit of help. Thus, describe at a high/medium level (as appropriate) as code comments. Use judgement to determine if something is already clear. (that is the following is probably not necessary)

// performs normalization on an image
normalizeImage(img)

We'll probably break this into subtasks, depending on what PRs come in.

birm avatar Jun 24 '20 03:06 birm

Can I help through it

Saurav-Majumder avatar Jul 05 '20 08:07 Saurav-Majumder

Is this issue still open?

anumi1999 avatar Jan 18 '21 15:01 anumi1999

Yes, thanks for your interest. I'd recommend doing some small sections first so we can review before you put too much time into it.

birm avatar Jan 19 '21 17:01 birm

Made some changes in the documentation please have a look and review

anumi1999 avatar Jan 23 '21 07:01 anumi1999

Is this issue still open? Are contributions welcome?

AkhileshAdithya avatar Mar 17 '21 03:03 AkhileshAdithya

Yes, we'll always review PRs which improve documentation meaningfully. :smile:

birm avatar Mar 17 '21 15:03 birm

is this still open? Can I contribute to it?

garvpatidar04 avatar Jan 24 '23 10:01 garvpatidar04

I would like to work on this Issue. @birm

ashutosh887 avatar Feb 25 '23 15:02 ashutosh887

May I inquire whether this opportunity is presently available for contribution? If so, I would appreciate the chance to make a contribution.

AdarshRawat1 avatar Feb 26 '23 06:02 AdarshRawat1

We welcome pull requests on open issues from anyone!

birm avatar Feb 26 '23 09:02 birm

is this still open? i would like to contribute

ikrammirza avatar Mar 01 '23 11:03 ikrammirza

I would like to contribute in this !

Znoy108x avatar Mar 03 '23 02:03 Znoy108x

is this open? Can i contribute!

0nikhilkumar avatar Mar 03 '23 06:03 0nikhilkumar

I would like to contribute int this

Sankalp-sa avatar Mar 03 '23 16:03 Sankalp-sa

Is this open? Can I contribute?

Sam-1806 avatar Mar 04 '23 18:03 Sam-1806

I would like to contribute in this as i am good at documentation.

Shubhisingh921 avatar Mar 05 '23 10:03 Shubhisingh921

I would like to contribute in documentation.

amancod1 avatar Mar 05 '23 10:03 amancod1

i would like to contribute to this,if it is open.

affusul avatar Mar 05 '23 11:03 affusul

I'm going to close this issue, not because it is done, but because it can never really be "finished". I will still accept pull requests which meaningfully improve documentation.

birm avatar Mar 06 '23 03:03 birm

Hey, Birm I understand your concern but I would like to give it a try. I am good at managing and writing documentation. I have written couple of documentation for several projects and I believe that I can help at this. I hope you will give me a chance. Thanking You

niikkhilsharma avatar Mar 16 '23 20:03 niikkhilsharma