Skip to content

Unclear docstring for arc in drawDobot.py #44

@HanBnrd

Description

@HanBnrd

The arc method in drawDobot.py has an unclear docstring:

def arc(self, x, y, z, r, cir_x, cir_y, cir_z, cir_r, wait=True):
Draws an arc defined by a) circumference of arc (x, y, z, r),
with b) a finishing coordinates (cirx, ciry, cirz, cirr.

Should it be instead:

Draws an arc defined by a) circumference of arc finishing coordinates (x, y, z, r),
and b) a finishing coordinates circumference of the arc (cir_x, cir_y, cir_z, cir_r).
?

Maybe "circumference" could be clarified as well.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions