Documenting the python package

[akchobby]

The python package of transforms needs to be documented well, such that it can be added to python public libraries

[TechnicalAmanjeet]

I love to work on this issue. but I don't get it what needs to be done. could you please explain it in detail?

[akchobby]

Hey @TechnicalAmanjeet ,

The idea is to fill up docstring for the python package (details of each function) such that sphinx documentation can be auto generated. There is partial example of it here

A good source on how to write docstring can be found here

[akchobby]

An update on this , I've added a skeleton for the docstring, the example

Transforms/python/src/transforms_package/quaternion.py

Lines 258 to 269 in 9c7816f

	"""[summary]
	:param ax: [description]
	:type ax: [type]
	:param rotation: [description], defaults to None
	:type rotation: [type], optional
	:param translation: [description], defaults to [0.0,0.50,0]
	:type translation: list, optional
	:param names: [description], defaults to ["test"]
	:type names: list, optional
	"""

as one can see the explanation has to be added

@TechnicalAmanjeet this should make it much easier to complete the task