Improve API documentation

This commit is contained in:
Jo Liss 2011-12-29 18:45:58 +01:00
parent 71fd12613b
commit fc44375ef7
1 changed files with 4 additions and 7 deletions

View File

@ -70,7 +70,7 @@ module Capybara
## ##
# #
# The current Capybara::Session base on what is set as Capybara.app and Capybara.current_driver # The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver
# #
# @return [Capybara::Session] The currently used session # @return [Capybara::Session] The currently used session
# #
@ -120,8 +120,7 @@ module Capybara
## ##
# #
# Shortcut to working in a different session. This is useful when Capybara is included # Shortcut to working in a different session.
# in a class or module.
# #
def using_session(name, &block) def using_session(name, &block)
Capybara.using_session(name, &block) Capybara.using_session(name, &block)
@ -129,8 +128,7 @@ module Capybara
## ##
# #
# Shortcut to working in a different session. This is useful when Capybara is included # Shortcut to using a different wait time.
# in a class or module.
# #
def using_wait_time(seconds, &block) def using_wait_time(seconds, &block)
Capybara.using_wait_time(seconds, &block) Capybara.using_wait_time(seconds, &block)
@ -138,8 +136,7 @@ module Capybara
## ##
# #
# Shortcut to accessing the current session. This is useful when Capybara is included in a # Shortcut to accessing the current session.
# class or module.
# #
# class MyClass # class MyClass
# include Capybara::DSL # include Capybara::DSL