The required Javadoc class comments seem overly complicated

[nqafield]

A brief description of what a class represents is no doubt often useful, but the rest seems unnecessary.

• The comments actually clutter and lengthen the file making it harder to mentally process, not easier.
• There doesn't seem to be any point knowing the (original) author of a class. This can be found out from version control but isn't it also irrelevant once enough changes have happened?
• I haven't been able to ascertain the usefulness of the @Version and @SInCE things.

Would it be possible to only require the description mentioned above?

(See further discussion here: objectionary/eo#108)

[0crat]

@yegor256 please, pay attention to this issue

[krzyk]

@pa9ey

• @author, it was already reported here - Prohibit usage of '@author' Javadoc tag #761 (but no budget to work on it)
• @version I don't find it useful (was used in the cvs/svn days, but in git, I haven't seen it much - one has to enable it explicitly in .gitattributes) - so I agree, we should get rid of it.
• @since that one I find useful, when you use an older library and read newer javadocs, or in similar cases (JDK API is a good example, they don't keep it everywhere, but it is useful).

[nqafield]

Thanks for the info @krzyk.

[nqafield]

So, do I close this? And/or do I open an issue about getting rid of @version?

[krzyk]

@0crat in

[0crat]

@0crat in (here)

@krzyk Job #823 is now in scope, role is DEV

[0crat]

@0crat in (here)

@krzyk Thanks for your contribution, @nqafield/z! If you would be a member of the project, you would now earn +15 reputation points, as explained in §29. You can join and apply to it, see §2.

[nqafield]

@0crat apply

[0crat]

@0crat apply (here)

@nqafield Can't understand "apply", try one of these:

• assign Assign a performer to this issue
• boost Set a boost for the job
• hello Just say hello
• in Register this issue in scope (WBS)
• out Close the order and remove this job from scope
• pay Pay a user some extra cash
• quality Review a task
• resign Resign from this issue
• status Check the status of the job
• version Print current version of the bot
• wait Register an impediment for a job

[0crat]

@krzyk/z everybody who has role DEV are banned at this job; I won't be able to assign anyone automatically; consider assigning someone manually (as in §19), or invite more people (as in §51), or remove the job from the scope (as in §14)

[krzyk]

@nqafield If you want to apply go to https://www.0crat.com/join and fill out the form

[nqafield]

Thanks @krzyk. Not too bothered about joining the project (except that @0crat suggested it - but I don't actually think I'm much use at the moment) but I've reported the issue here: #882

[0crat]

Are you speaking to me or about me here; you must always start your message with my name if you want to address it to me, see §1

[krzyk]

@nqafield This issue you should report in https://github.com/zerocracy/farm/issues project (that's where @0crat comes from :) ).
As for joining, yeah this project is not on the board, you can join by saying /apply C3T49A35L (the code you can find in the url when you look at the project link) in in telegram chat with 0crat.

[0crat]

Are you speaking to me or about me here; you must always start your message with my name if you want to address it to me, see §1

[nqafield]

@0crat sorry! ;)

[0crat]

@0crat sorry! ;) (here)

@nqafield Can't understand "sorry!", try one of these:

• assign Assign a performer to this issue
• boost Set a boost for the job
• hello Just say hello
• in Register this issue in scope (WBS)
• out Close the order and remove this job from scope
• pay Pay a user some extra cash
• quality Review a task
• resign Resign from this issue
• status Check the status of the job
• version Print current version of the bot
• wait Register an impediment for a job

[krzyk]

@0crat assign me

[0crat]

@0crat assign me (here)

@krzyk The job #823 assigned to @krzyk/z, here is why; the budget is 30 minutes, see §4; please, read §8 and §9; if the task is not clear, read this and this

[0crat]

Manual assignment of issues is discouraged, see §19: -5 point(s) just awarded to @krzyk/z

[krzyk]

@nqafield please close this issue, the fix was merged to master in #886

[0crat]

Order was finished: +30 point(s) just awarded to @krzyk/z

[0crat]

The job #823 is now out of scope