close
The Wayback Machine - https://web.archive.org/web/20201102014548/https://github.com/mithi/hexapod-robot-simulator/issues/68
Skip to content

/ hexapod-robot-simulator

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstrings for public packages etc #68

Open
mithi opened this issue Apr 19, 2020 · 4 comments
Open

Add docstrings for public packages etc #68

mithi opened this issue Apr 19, 2020 · 4 comments
Labels
code quality documentation first-timers-only good first issue low hanging fruit

Comments

@mithi
Copy link
Owner

@mithi mithi commented Apr 19, 2020 •
edited

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
Copy link
Owner Author

@mithi mithi commented May 24, 2020 •
edited

Particularly, fix the docstring of the following two modules so that the algorithm is easier to understand:
@mithi mithi pinned this issue Jun 17, 2020
@mithi mithi unpinned this issue Jun 17, 2020
@myiwt
Copy link

@myiwt myiwt commented Sep 3, 2020

Hi, would you still like help with this?
@mithi
Copy link
Owner Author

@mithi mithi commented Oct 6, 2020

@memoisaaclo
Copy link

@memoisaaclo memoisaaclo commented Oct 20, 2020

Sounds good!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code quality documentation first-timers-only good first issue low hanging fruit
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@mithi @myiwt @memoisaaclo
You can’t perform that action at this time.