Adding some doc examples - Issues258 #527
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -288,6 +335,65 @@ def place_order(self, **kwargs): | |||
| :param boolean no_public: True if this server should only have private | |||
| interfaces | |||
| :param list extras: List of extra feature names | |||
|
|
|||
| .. warning:: | |||
There was a problem hiding this comment.
This example/description is no longer true. place_order uses the simplified hardware ordering and is able to take more-or-less human readable values. See the new slcli server create-options and slcli server create commands to see how it works now.
|
Removed the examples for place order, when I figure out the new hotness I'll add a more relevant example. I removed the cancel_metal example |
| @@ -26,6 +26,15 @@ class HardwareManager(utils.IdentifierMixin, object): | |||
| manager to handle ordering. | |||
| If none is provided, one will be | |||
| auto initialized. | |||
| Example:: | |||
| # Initialize the Manager. | |||
There was a problem hiding this comment.
A blank line is required after Example::
| Example:: | ||
|
|
||
| # Cancels hardware id 1234 | ||
| result = mrg.cancel_hardware(hardware_id=1234) |
There was a problem hiding this comment.
Should this be mgr?
underscorephil
added a commit
that referenced
this pull request
Aug 11, 2015
Adding some doc examples - Issues258
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
some basic examples on the vs and sever managers mostly.