Skip to content

Commit

Permalink
Documentation corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
relaxdiego committed Dec 10, 2014
1 parent 1b98968 commit 86530c7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 20 deletions.
13 changes: 7 additions & 6 deletions lib/aviator/core/session.rb
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
#
# Author:: Mark Maglana (mmaglana@gmail.com)
# Copyright:: Copyright (c) 2014 Mark Maglana
# License:: Distributed under the MIT license
# Homepage:: http://aviator.github.io/www/
#
module Aviator

#
# Manages a provider (e.g. OpenStack) session.
#
# Author:: Mark Maglana (mmaglana@gmail.com)
# Copyright:: Copyright (c) 2014 Mark Maglana
# License:: Distributed under the MIT license
# Homepage:: http://aviator.github.io/www/
#
class Session

class AuthenticationError < StandardError
Expand Down Expand Up @@ -360,7 +361,7 @@ def log_file
# session.request :compute_service, :create_server, :api_version => v1
#
# The available options vary depending on the provider. See the documentation
# on the provider's Provider class for more information (e.g. Aviator::OpenStack::Provider)
# on the provider's Provider class for more information (e.g. Aviator::Openstack::Provider)
#
def request(service_name, request_name, opts={}, &params)
service = send("#{service_name.to_s}_service")
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Original work by Stephen Paul Suarez
# https://github.com/musashi-dev/aviator/blob/develop/lib/aviator/openstack/identity/v3/public/create_token.rb

module Aviator
# Original work by Stephen Paul Suarez
# https://github.com/musashi-dev/aviator/blob/develop/lib/aviator/openstack/identity/v3/public/create_token.rb

define_request :create_token, :inherit => [:openstack, :common, :v3, :public, :base] do

Expand Down
15 changes: 4 additions & 11 deletions lib/aviator/openstack/provider.rb
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
module Aviator
module Openstack

#
# Manages a provider (e.g. OpenStack) session.
#
# Author:: Mark Maglana (mmaglana@gmail.com)
# Copyright:: Copyright (c) 2014 Mark Maglana
# License:: Distributed under the MIT license
# Homepage:: http://aviator.github.io/www/
#
# <b>Request Options</b>
#
Expand All @@ -16,10 +9,10 @@ module Openstack
#
# :api_version => :v2::
# Forces Aviator to use the request class for the v2 API. For any other
# version, replace Note that this may throw an error if no such request
# class exists. If you want to globally specify the API version to use for
# a specific service, declare it in your config file under the correct
# environment. For example:
# version, replace :v2 with the desired one. Note that this may throw an
# error if no such request class for the given api version exists. If you
# want to globally specify the API version to use for a specific service,
# declare it in your config file under the correct environment. For example:
#
# production:
# provider: openstack
Expand Down

0 comments on commit 86530c7

Please sign in to comment.