Project

General

Profile

Actions

Bug #24964

closed

Document how to deprecate commands

Added by Andrew Kofink almost 6 years ago. Updated about 5 years ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
-
Difficulty:
Triaged:
No
Team Backlog:
Fixed in Releases:
Found in Releases:
In Kanboard:

Description

This PR (https://github.com/theforeman/hammer-cli/pull/251) introduced the ':warning' and ':hidden' options to subcommands, allowing us to show deprecation warnings when a user uses the command (e.g. https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman.rb#L106). We should have some documentation in the readme to show how this is done rather than relying on developers to search through PRs and grep code to figure it out.


Related issues 1 (0 open1 closed)

Related to Hammer CLI - Tracker #24973: Tracker for missing documentationClosed

Actions
Actions

Also available in: Atom PDF