Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

POD details #1023

Merged
merged 3 commits into from

3 participants

@isync

Added the defaults to the POD, as I had to dig into the source to find them. Also, some notes on defaults for Config.pm. Feel free to cherry-pick if you dislike anything.

@racke
Owner

Looks good. I suppose it would be a good idea to just put the default for the configuration setting in the =head line instead of the body (Commit fdce12b).

Regards
Racke

@yanick
Owner

Merged, thanks!

@yanick yanick merged commit fdce12b into from
@yanick yanick referenced this pull request from a commit
@yanick yanick Merge branch 'pr/1023' into devel
Fixes #1023
537b0a1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 2, 2014
  1. @isync

    Update Cache.pm

    isync authored
  2. @isync

    Update Config.pm

    isync authored
  3. @isync

    Update Config.pm

    isync authored
This page is out of date. Refresh to see the latest.
Showing with 13 additions and 12 deletions.
  1. +11 −11 lib/Dancer/Config.pm
  2. +2 −1  lib/Dancer/Route/Cache.pm
View
22 lib/Dancer/Config.pm
@@ -457,23 +457,23 @@ L<Dancer::Config::Object> for more information.
=head3 global_warnings (boolean, default: false)
If true, C<use warnings> will be in effect for all modules and scripts loaded
-by your Dancer application. Set to a true value to enable this.
+by your Dancer application. Default is false.
=head3 startup_info (boolean)
-If set to true, prints a banner at the server start with information such as
-versions and the environment (or "dancefloor").
+If set to true (the default), prints a banner at server startup with information such as
+versions and the environment (or "dancefloor"). Default is true.
Conforms to the environment variable DANCER_STARTUP_INFO.
=head3 warnings (boolean)
-If set to true, tells Dancer to consider all warnings as blocking errors.
+If set to true, tells Dancer to consider all warnings as blocking errors. Default is false.
=head3 traces (boolean)
If set to true, Dancer will display full stack traces when a warning or a die
-occurs. (Internally sets Carp::Verbose). Default to false.
+occurs. (Internally sets Carp::Verbose). Default is false.
=head3 require_environment (boolean)
@@ -484,8 +484,8 @@ Default to false.
=head3 server_tokens (boolean)
-If set to true, Dancer will add an "X-Powered-By" header and also append
-the Dancer version to the "Server" header. Default to true.
+If set to true (the default), Dancer will add an "X-Powered-By" header and also append
+the Dancer version to the "Server" header. Default is true.
You can also use the environment variable C<DANCER_SERVER_TOKENS>.
@@ -657,16 +657,16 @@ so don't use the feature for anything else.
=head3 route_cache (boolean)
-Enables route caching (for quicker route resolution on larger apps - not caching
-of responses). See L<Dancer::Route::Cache> for details.
+If true, enables route caching (for quicker route resolution on larger apps - not caching
+of responses). See L<Dancer::Route::Cache> for details. Default is false.
=head3 route_cache_size_limit (bytes)
-Maximum size of route cache (e.g. 1024, 2M) - see L<Dancer::Route::Cache>
+Maximum size of route cache (e.g. 1024, 2M). Defaults to 10M (10MB) - see L<Dancer::Route::Cache>
=head3 route_cache_path_limit (number)
-Maximum number of routes to cache - see L<Dancer::Route::Cache>
+Maximum number of routes to cache. Defaults to 600 - see L<Dancer::Route::Cache>
=head2 DANCER_CONFDIR and DANCER_ENVDIR
View
3  lib/Dancer/Route/Cache.pm
@@ -153,7 +153,8 @@ Dancer::Route::Cache - route caching mechanism for L<Dancer>
=head1 SYNOPSIS
my $cache = Dancer::Route::Cache->new(
- path_limit => 300, # optional
+ path_limit => 300, # optional, defaults to 600 (routes to cache)
+ size_limit => 5M, # optional, defaults to 10M (10MB)
);
# storing a path
Something went wrong with that request. Please try again.