Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fix rdoc around env_name

  • Loading branch information...
commit a1d012b6278ece42bb2c5be828c43bdb5c762d15 1 parent 807373f
@durran durran authored
Showing with 3 additions and 1 deletion.
  1. +3 −1 lib/mongoid/config/environment.rb
View
4 lib/mongoid/config/environment.rb
@@ -8,11 +8,13 @@ module Environment
# Get the name of the environment that we are running under. This first
# looks for Rails, then Sinatra, then a RACK_ENV environment variable,
- # and if none of those are found returns "development".
+ # and if none of those are found raises an error.
#
# @example Get the env name.
# Environment.env_name
#
+ # @raise [ Errors::NoEnvironment ] If no environment was set.
+ #
# @return [ String ] The name of the current environment.
#
# @since 2.3.0
Please sign in to comment.
Something went wrong with that request. Please try again.