chef

https://github.com/opscode/chef

Ruby

A systems integration framework, built to bring the benefits of configuration management to your entire infrastructure.

Chef::Mixin.deprecate_constant

Add a deprecated constant to the Chef::Mixin namespace.
=== Arguments
* name: the constant name, as a relative symbol.
* replacement: the constant to return instead.
* message: A message telling the user what to do instead.
=== Example:
  deprecate_constant(:RecipeDefinitionDSLCore, Chef::DSL::Recipe, <<-EOM)
    Chef::Mixin::RecipeDefinitionDSLCore is deprecated, use Chef::DSL::Recipe instead.
  EOM

Source | Google | Stack overflow

Edit

git clone [email protected]:opscode/chef.git

cd chef

open lib/chef/mixin/deprecation.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Chef--Mixin-deprecate_constant-for-pr

# Commit to git

git add lib/chef/mixin/deprecation.rbgit commit -m "better docs for Chef::Mixin.deprecate_constant"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Chef--Mixin-deprecate_constant-for-pr

hub pull-request

# Celebrate!