protoloft / klipper_z_calibration

Klipper plugin for self-calibrating z-offset
GNU General Public License v3.0
1.06k stars 152 forks source link

Wiki Changelog describes need to change "safe_z_home" instead of "safe_z_height" #120

Closed mk-maddin closed 1 year ago

mk-maddin commented 1 year ago

The changelog for v1.0.0 (2023-04-25) describes: "_The clearance is deprecated and is replaced by the safe_z_home due to the change in behavior. The safe_zhome is now an absolute z position to move to." and "_Move from clearance to safe_zhome"

But as of Configuration information it should be "safe_z_height":

clearance: DEPRECATED - please use safe_z_height instead!
#   The distance in mm to move up before moving to the next
#   position. The default is two times the z_offset from the probe's
#   configuration.

With replacing clearance with safe_z_home klipper throws error: "_Option 'safe_z_home' is not valid in seciton 'zcalibration'" With safe_z_height it works as expected. Due to this I am assuming this is a typo within the changelog.

TitusLabs commented 1 year ago

Hi, thanks for the hint! I've changed it :+1:

NateroniPizza commented 2 months ago

@TitusLabs , should the second instance of "safe_z_home" be also replaced by "safe_z_height?" I just spent quite a while troubleshooting why it wouldn't work, without realizing there was a difference between the two, having copied the second one: image