remove pointless comments

[hannesa2]

especially where I'm the last changed user and git blame points to me.

It's just noise

[hannesa2]

@michaelstingl It looks like your tests are broken, even removing pointless comments fails.
How can this happen ?

[jesmrec]

@hannesa2 sometimes, the BitRise fails due to some timeouts or performance problems in its internal emulators. We are looking for the best solutions.

[abelgardep]

From my point of view it is important to have gradle files organized. We are working on modularization, so we will have a build gradle file for each module. It is important to have them localized and commented in some way. What do you think @davigonz ?

[hannesa2]

From my point of view it is important to have gradle files organized.

You can organise them like you want, but

but this comment (and the others) has no purpose, except noise. And worst, git blame shows me, I'm the commiter

[davigonz]

@hannesa2 I'm in favor of not writing comments everywhere but providing that the code is self explanatory enough. As I wrote in the code review, some of the comments in the build.gradle can be removed for sure but there are others that would be very useful for someone new in the project who does not necessarily need to know what every dependency is for.

Imagine that someone wants to work on the image loading and goes to the build.gradle file to research about the library being used. It would be impossible to find it without proper comments.

[hannesa2]

Now I keep a lot of pointless comments. -sad-

It's always a question for whom you write comments. For pros or beginners. There are some who always scream for more documentation, but this ones you will never satisfy, because they have other issues

Documentation is like a newspaper: When it's printed, it's outdated. After some time documentation is just garbage

[davigonz]

@hannesa2

It's always a question for whom you write comments. For pros or beginners.

I would say that comments should not explain everything from scratch, e.g. people who don't know what is an AndroidManifest.xml, it does not make any sense to explain with comments what is the AndroidManifest used for and as you say, they have many other issues that can be solved by reading/practicing more Android development.

In our case, this is an open source project and it's very common to have beginners developers. In deed, I have had to explain many things from scratch to some people and is not a problem for me.

About this PR, I think that some comments that you wanted to remove from build.gradle are not only for beginners, someone with much experience might not know that glide library is used for image loading for example.

Documentation is like a newspaper: When it's printed, it's outdated. After some time documentation is just garbage

I do not fully agree with you, it's true that the documentation ends up being outdated but is no excuse for not writing documentation or putting some comments when needed. A comment from time ago can be useful for me now and we also read Android documentation (new and a bit old) very often as well 😄

[hannesa2]

Let's stop this senseless discussion. That means you keep my name on this pointless comment during git blame

[davigonz]

I don't understand the reason for closing this PR now, when you have already applied the changes I requested yesterday.

The code is approved, @jesmrec no QA needed, I will merge it when all the checks are green