cliff

Add ability to mark commands deprecated so they no longer appear in help output

Bug #1411025 reported by Dean Troyer on 2015-01-14

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	cliff	Fix Released	Wishlist	Dean Troyer	cliff 1.10.0

Deprecated commands often should not show up in help output, there does not seem to be a way to subclass HelpAction to skip specific commands.

A simple help_output attribute added to Command would suffice, default to True, and HelpAction can skip commands with help_output=False.

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-01-15: Fix proposed to cliff (master)

Fix proposed to branch: master
Review: https://review.openstack.org/147349

Doug Hellmann (doug-hellmann) on 2015-02-02

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-02-25: Fix merged to cliff (master)

commit da46b647aadd9ffdaab62ed82dcd660e39078904
Author: Dean Troyer <email address hidden>
Date: Wed Jan 14 17:44:48 2015 -0600

Add deprecated attribute to commands

This atttribute will remove commands from help output when True.

This change is necessary here as there is no simple way to change HelpAction's
behaviour without completely re-writing it.

Closes-bug: #1411025
Change-Id: I5bb140ac3a7f5f12f95cc9dee3da91485f9a249b

Changed in python-cliff:
status:	In Progress → Fix Committed

Doug Hellmann (doug-hellmann) on 2015-03-03

Changed in python-cliff:
status:	Fix Committed → Fix Released

This report contains Public information

Everyone can see this information.

You are

Subscribing...

Bug watches keep track of this bug in other bug trackers.