gin66 / FastAccelStepper

A high speed stepper library for Atmega 168/328p (nano), Atmega32u4, Atmega 2560, ESP32, ESP32S2, ESP32S3, ESP32C3 and Atmel SAM Due
MIT License
282 stars 67 forks source link

Improve documentation for stepper_command_s #269

Closed HalfVoxel closed 1 week ago

HalfVoxel commented 1 week ago

I spent the last 2 hours being confused about why my code didn't work, until I figured out that I had assumed that ticks was the total number of ticks in the command, not the spacing between the ticks. Hopefully, better documentation will ensure no other people fall into the same trap.