search

akchobby / Transforms

A repository which contains a library for quaternions and rotation matrices. Languages it is available in are: C++ and python
0 stars 0 forks source link

Documenting the python package #3

Open akchobby opened 2 years ago

akchobby commented 2 years ago

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

TechnicalAmanjeet commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

An update on this , I've added a skeleton for the docstring, the example https://github.com/akchobby/Transforms/blob/9c7816f38c356735e44c988aa71a7526e9d85220/python/src/transforms_package/quaternion.py#L258-L269

as one can see the explanation has to be added

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