Commits

Herbert Breunung committed f7e5fec

revamp first section of internal docs

Comments (0)

Files changed (4)

 
 package Kephra;
 our $NAME     = __PACKAGE__;    # name of entire application
-our $VERSION  = '0.4.5.11';
+our $VERSION  = '0.4.5.12';
 
 our @external_dependencies = (
 	qw/Benchmark Encode Encode::Guess Cwd/,

lib/Kephra/API.pm

 
 
 package Kephra::API;
-my $VERSION = 0.1;
-
+my $VERSION = 0.5;
 
 Kephra::API::Command::switch_variables({
  '$app'    => { switch => 'app',         class => 'Kephra::App' },

lib/Kephra/Internals.pod

 =head2 Kephra::API
 
 The module Kephra::API is the best starting point to understand the inner workings.
-Thats's one design goal and purpose of this file, because it gives an overview of
-the most important functions and values and shows where they originate. From here
-you can step to the other major interfaces that can be seen in the first lines.
+It's one design goal and purpose of this file, because it naturally gives an
+overview of the most important functions and values and there origin. From here
+you can step to the other major interfaces that are included there with C<use>
+in the first lines.
 
 But more vitally it decouples many cross module calls and allows to change things
 under the hood during smaller release cycles. As long as the first version number
-(see L<Versioning>) does not change, nothing will be removed from the API.
+(see L<Versioning>) does not change, nothing will be renamed or removed from the API.
 
 
 =head1 NAMESPACES
 
-If you want to leave the recommended ways as proposed by the API
-and call functions or data directly ...
+If you want to leave the recommended ways as proposed by the API and call
+functions or data directly (or even better you want to help to develope Kephra) ...
 here is an overview to the Kephra namespace organisation.
 
-Please not that as shorter the name is (shorter namespace chain),
+Please note that the shorter the name is (shorter namespace chain),
 the more internal and general purpose the module is owning that name.
 For instance Kephra::File::Local serves as specialized subtask of Kephra::File.
 

t/610-api-command.t

 package C;
 sub color   { Kephra::App::Util::create_color("blue") }
 
-package Kephra::API;
+package Kephra::API;              # only from here you can register a switch var
 Kephra::API::Command::switch_variables({
  '$color'    => { switch => 'colour',   class => 'C' },
 });
 
 my $data = Kephra::API::Command::all_properties('test-true');
 my $blue = Kephra::App::Util::create_color("blue");
-is( ref $data,                              'HASH', 'package completion when omiting current package name');
+is( ref $data,                                          'HASH', 'package completion when omiting current package name');
 is( Kephra::API::Command::run('test-color')->Blue, $blue->Blue, 'calling different package');
-is( Kephra::API::Command::run('test-gc'),        1, 'named switch var substitution');
-is( Kephra::API::Command::run('test-chan'),      4, 'parameter insertion');
+is( Kephra::API::Command::run('test-gc'),                    1, 'named switch var substitution');
+is( Kephra::API::Command::run('test-chan'),                  4, 'parameter insertion');
 
 
 exit(0);