Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

functions in drac.py module do not match documentation #23788

Closed
k5jj opened this issue May 15, 2015 · 2 comments
Closed

functions in drac.py module do not match documentation #23788

k5jj opened this issue May 15, 2015 · 2 comments
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation P2 Priority 2 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Milestone

Comments

@k5jj
Copy link

k5jj commented May 15, 2015

Documentation for drac.py module has incorrect CLI example for the network_info() and system_info() functions.

Using the CLI example will produce an error. For example, "salt dell drac.getniccfg" returns and error, but "salt dell drac.network_info" returns expected out from the function. Same is true for "salt dell drac.getsysinfo" versus "salt dell drac.system_info"

Documentation here: http://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.drac.html#module-salt.modules.drac

Module source here: https://github.com/saltstack/salt/blob/develop/salt/modules/drac.py

@jfindlay jfindlay added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around P2 Priority 2 labels May 18, 2015
@jfindlay jfindlay added this to the Approved milestone May 18, 2015
@jfindlay
Copy link
Contributor

@k5jj, thanks for the report. You are welcome to submit a pull request to fix this to the oldest supported branch, see https://docs.saltstack.com/en/latest/topics/development/contributing.html#which-salt-branch. Be sure to reference this issue if you do.

jacobhammons added a commit to jacobhammons/salt that referenced this issue Jul 30, 2015
@rallytime
Copy link
Contributor

This has been fixed with #25894, as can be seen here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation P2 Priority 2 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Projects
None yet
Development

No branches or pull requests

3 participants