Add documentation for too-many-lines

[ollie-iterators]

Type of Changes

	Type
✓	🐛 Bug fix
✓	✨ New feature
✓	🔨 Refactoring
✓	📜 Docs

Description

Adding documentation for too-many-lines

Refs #5953

Closes #XXXX

[clavedeluna]

I'd argue that the good v. bad examples are confusing because by adding code that's actually different (loop in good v. lots of print statements in bad), it's honing in on other code issues and not just too many lines in the module.

I'd suggest doing something way simpler, make the config for line number be something small like 3 and then have almost identical code in good/bad files but just one more line in bad.

[ollie-iterators]

I'd argue that the good v. bad examples are confusing because by adding code that's actually different (loop in good v. lots of print statements in bad), it's honing in on other code issues and not just too many lines in the module.

I'd suggest doing something way simpler, make the config for line number be something small like 3 and then have almost identical code in good/bad files but just one more line in bad.

@clavedeluna - Ok, do you think this code for bad.py is good:

Imports

import datetime
from datetime import datetime
from datetime import date, timedelta

print("Current date and time: " , datetime.datetime.now())
print("Current year: ", datetime.date.today().strftime("%Y"))
print("Month of year: ", datetime.date.today().strftime("%B"))
print("Week number of the year: ", datetime.date.today().strftime("%W"))
print("Weekday of the week: ", datetime.date.today().strftime("%w"))
print("Day of year: ", datetime.date.today().strftime("%j"))
print("Day of the month : ", datetime.date.today().strftime("%d"))
print("Day of week: ", datetime.date.today().strftime("%A"))

And a for loop with some of those values in a list for the good.py file?

[clavedeluna]

How about something as simple as:

max line number : 3

bad.py
print(1)
print(2)
print(3)

good:
print(1)
print(2)

but maybe another maintainer will disagree with me

[Pierre-Sassoulas]

#8219 (review)
#7897 (comment)

Please don't reopen issue when it was already rejected, you're wasting everyone's time.

[ollie-iterators]

#8219 (review) #7897 (comment)

Please don't reopen issue when it was already rejected, you're wasting everyone's time.

@Pierre-Sassoulas Please look at the discussion that was happening above.

[Pierre-Sassoulas]

Too many lines is not a message that can be properly reported with a good/bad example, it's also not a concept that is hard to grasp and absolutely needs an example to be understood. But it does need a rational. This is why we're going to use a template without good/bad to document it.

I've already reviewed your proposal yesterday and closed your issue, please take reviews and review comments into account if you want to keep contributing to pylint.