Docstring improvements.

[onekk]

Very often docstrings are lacking, using the autocomplete function in Python console or :

Code: Select all

print(dir(Part.Something))

Many methods don't show anything or a mere "this methods are docing this"

Without a proper docstring like:

Code: Select all

"""This method is doing this:
    Part.Something(center, point, refine)	
    ....

Parametrs:
	center  Vector      center of Something default: (0,0,0)
	point    Vector      point to compare default: None
	refine  boolean    refine the final object default: False
....

As FreeCAD is becoming more widespread and many people come here asking for helps, it will be a "very good" improvement.

It will be also a "time saving" thing as some repeated answers could simply be addressed pointing to the "documentation".

Regards

Carlo D.

[Kunda1]

+1

edit: is there a way to make a roadmap of what has been documented and what still needs documentation?

[onekk]

Another problem possible quirk.

Are developer aware of the importance of a proper "docstring" from some code analisys it seems that "mileage may vary" some developers are very "prone" to document using comments but write "poor" if not non existent docstrings.
Some other write very good docstrings and maybe document very well, sometimes even with reference to the documentation from where formulas were taken, or even with url to some web pages and so on.

Regards

Carlo D.