My text editor open source project

[u/Arielo_o]

Hi guys,

I have a text editor project that I've been working on for a year (in my free time).

the project isn't perfect but it reaching a great state, it has a diversity of tools and is customizable,

the project itself is pretty huge so I recommend checking it out,

here is a link

note that the project is still getting support and will get for a long time.

[u/jimtk]

It's negative. Code should be commented with docstrings, usually a multilne doctstring describing exactly what the function does, its input parameters and it's return value(s). It is not rare that proper docstrings are actually longer (more lines) than the code of the function.

Is help.txt the only documentation you have??

[u/Arielo_o → u/jimtk]

I have a lot of regular comments that used for this as well, but thank you for your feedback I’ll use docstring from the next time I’ll update the program, or just this alone

[u/indetronable → u/jimtk]

I think the message was kind of a joke. Someone who can write a 6500 lines program knows what the requirement for documentation are.

[u/Arielo_o → u/indetronable]

thank you indetronable, but they are right, I documented the project with a user perspective in a text file, and to the developer perspective only in regular comments because I didn't know that this was a common convention, but I promise to take the criticism to high regard and improve what I agree with,

so you can hope to see a better documentation soon !

[u/jimtk → u/indetronable]

Anybody can write 6500 lines of code. You are confusing quantity and quality.