zonemaster / zonemaster-cli

The Zonemaster CLI - part of the Zonemaster project
Other
20 stars 20 forks source link

Update documentation in zonemaster-cli script #336

Closed tgreenx closed 1 year ago

tgreenx commented 1 year ago

Purpose

This PR proposes an update to the script/zonemaster-cli file, in particular to be more in line with options (and their documentation) in lib/Zonemaster/CLI.pm.

Note that the content in script/zonemaster-cli deliberately provides slightly more detailed documentation than the one in lib/Zonemaster/CLI.pm. This stems from issue https://github.com/zonemaster/zonemaster-cli/issues/68 (not addressed in this PR), where documentation is done in two different places.

Context

Part of v2023.1 release testing

Also see https://github.com/zonemaster/zonemaster-cli/issues/68

Changes

script/zonemaster-cli

How to test this PR

Check that perldoc script/zonemaster-cli (or man zonemaster-cli) and zonemaster-cli -h provide similar, accurate information (although not an exact copy).