[GCI] Standardised Blob Analysis module comments

[harshkhandeparkar]

Fixes #1350 (<=== Replace 0000 with the Issue Number)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

• tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with npm test
• code is in uniquely-named feature branch and has no merge conflicts
• PR is descriptively titled
• ask @publiclab/is-reviewers for help, in a comment below
• Insert-step functionality is working correct as expected.

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software
Please make sure to get at least two reviews before asking for merging the PR as that would make the PR more reliable on our part
Thanks!

[harshkhandeparkar]

@SidharthBansal @jywarren here's the last PR with two more file changes. Please try to merge this soon as the deadline is only 2 days away. Thanks a lot to all!

[codecov]

Codecov Report

Merging #1351 into main will not change coverage.
The diff coverage is 0%.

@@           Coverage Diff           @@
##             main    #1351   +/-   ##
=======================================
  Coverage   66.41%   66.41%           
=======================================
  Files         125      125           
  Lines        2552     2552           
  Branches      397      397           
=======================================
  Hits         1695     1695           
  Misses        857      857

Impacted Files	Coverage Δ
src/modules/BlobAnalysis/Module.js	28.57% <0%> (ø)	⬆️

[SidharthBansal]

Tip: start opening ftos to get points.
Documentation from will contain points too.
If you are free you can do that. :-)
Don't write diff. Instead ask them what good documentation needs. And help them to implement good docs.
Don't provide diff. That is no learning from my point of view. Especially in case of documentation
Thanks 😊

[SidharthBansal]

Please don't create all documentation ftos in a single day. That will cause a flood of documentation and we need to close. So limit it to 1-2 per day.
However you can create as many non documentation ftos as you want per day in any repo.
Also, you can create 1-2 documentation ftos per day in other repos if you are familiar with the code.
Thanks

[harshkhandeparkar]

I know. I am going to open a few docs FTOs once this task is over. TY.

[harshkhandeparkar]

Have you read the sub-issues I opened? Do you think it will be good if I make more such issues but in the FTO format for GCI?

[SidharthBansal]

Commented on it. I asked you to open the other ftos so that you will remain not be blocked due to lesser availability of mentors. This year gci is epic so it is taking a lot of time.

…

On Wed, 11 Dec 2019, 8:55 pm Harsh Khandeparkar, ***@***.***> wrote: Have you read the sub-issues I opened? Do you think it will be good if I make more such issues but in the FTO format for GCI? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1351?email_source=notifications&email_token=AFAAEQYILO6M642K76CP7MTQYEA7PA5CNFSM4JZCBTT2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGTQUHY#issuecomment-564595231>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAAEQ7Y5VRMTO7N55B6RSLQYEA7PANCNFSM4JZCBTTQ> .

[SidharthBansal]

Kindly remove two .
Let's complete all your prs today. Only . errors are remaining I guess

[harshkhandeparkar]

Okay. Ty.

[SidharthBansal]

@jywarren kindly review and merge it
I am just trying to make docs consistent throughout the repo with help of Harsh.
THanks all

[SidharthBansal]

@jywarren kindly merge it

[jywarren]

Fantastic work! Thanks!!