hexapod-robot-simulator icon indicating copy to clipboard operation
hexapod-robot-simulator copied to clipboard

Add docstrings for public packages etc

Open mithi opened this issue 5 years ago • 6 comments

Public Packages

hexapod/
widgets/
pages/
tests/

Some public methods

hexapod/ik_solver/ik_solver2.py
- init 

hexapod/linkage.py
- init
- str
- repr

hexapod/points.py
- init
- repr
- str
- eq

hexapod/models.py
- for VirtualHexapod
- for Hexagon

See also: https://www.python.org/dev/peps/pep-0257/

mithi avatar Apr 19 '20 21:04 mithi

Particularly, fix the docstring of the following two modules so that the algorithm is easier to understand:

  • https://github.com/mithi/hexapod-robot-simulator/blob/master/hexapod/ground_contact_solver/ground_contact_solver.py

  • https://github.com/mithi/hexapod-robot-simulator/blob/master/hexapod/ground_contact_solver/ground_contact_solver2.py

mithi avatar May 24 '20 12:05 mithi

Hi, would you still like help with this?

myiwt avatar Sep 03 '20 18:09 myiwt

ok cool! feel free to ask me about anything! and dont forget to read the contribution and commit style guide :)

On Wed, Oct 7, 2020 at 5:56 AM Isaac Lo [email protected] wrote:

Hey I'm going to try my best to help you, but—disclaimer—I'm new and I'm not sure if it's going to be good.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/mithi/hexapod-robot-simulator/issues/68#issuecomment-704574251, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMX2FMLE6ISDXO5P3HFC6LSJOG7LANCNFSM4ML6ZLGA .

mithi avatar Oct 06 '20 22:10 mithi

Sounds good!

memoisaaclo avatar Oct 20 '20 14:10 memoisaaclo

Hi, I am new to open source and would like to contribute to this ticket. Is this still open?

pratheekcr avatar Jan 10 '21 02:01 pratheekcr

@pratheekcr

hey yes, more and better test cases are always welcome!

feel free to ask me about anything! and dont forget to read the contribution and commit style guide!

mithi avatar Jan 10 '21 05:01 mithi