From 68f441b440f7ad98b1eb6a5f1b15ea081427e606 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Joaqu=C3=ADn=20Atria?= Date: Mon, 29 May 2017 17:59:25 +0100 Subject: [PATCH] Fix typos in the documentation --- lib/Couchbase.pm | 4 ++-- lib/Couchbase/Bucket.pm | 36 ++++++++++++++++++------------------ lib/Couchbase/Constants.pm | 6 +++--- lib/Couchbase/Document.pm | 14 +++++++------- lib/Couchbase/Settings.pm | 2 +- 5 files changed, 31 insertions(+), 31 deletions(-) diff --git a/lib/Couchbase.pm b/lib/Couchbase.pm index e9a44ef..5664184 100644 --- a/lib/Couchbase.pm +++ b/lib/Couchbase.pm @@ -113,10 +113,10 @@ can be found in the tests, which are actually in C. =head3 RELATION TO L This module B the older L module. Development -on the latter has ceased, ans it is no longer maintained. It is maintained +on the latter has ceased, and it is no longer maintained. It is maintained on CPAN purely so existing code using the module continues to function. -This module represents a complete rewrite of the older module +This module represents a complete rewrite of the older module. =head3 SUPPORT diff --git a/lib/Couchbase/Bucket.pm b/lib/Couchbase/Bucket.pm index aad33e9..7022bb6 100644 --- a/lib/Couchbase/Bucket.pm +++ b/lib/Couchbase/Bucket.pm @@ -284,7 +284,7 @@ Couchbase::Bucket - Couchbase Cluster data access Couchbase::Bucket is the main module for L and represents a data connection to the cluster. -The usage model revolves around an L which is updated +The usage model revolves around a L which is updated for each operation. Normally you will create a L and populate it with the relevant fields for the operation, and then perform the operation itself. When the operation has been completed the relevant @@ -331,7 +331,7 @@ to the C bucket. There are several options which can modify connection and general settings for the newly created bucket object. Some of these may be modifiable via L (returned via the C method) as well. This list only mentions those -settings which are specific to the initial connection +settings which are specific to the initial connection. =over @@ -390,7 +390,7 @@ not be made. =head2 DATA ACCESS -Data access methods operate on an L object. When the operation +Data access methods operate on a L object. When the operation has completed, its status is stored in the document's C field (you can also use the C method to check if no errors occurred). @@ -400,7 +400,7 @@ use the C method to check if no errors occurred). =head3 get_and_touch($doc) -Retrieve a document from the cluster. C<$doc> is an L. If the +Retrieve a document from the cluster. C<$doc> is a L. If the operation is successful, the value of the item will be accessible via its C field. @@ -470,7 +470,7 @@ integration with other optional functionality of the cluster (such as views and N1QL queries). You may also store items in other formats which may then be transparently serialized and deserialized as needed. -To specify the storage format for a document, specify the `format` setting +To specify the storage format for a document, specify the C setting in the L object, like so: use Couchbase::Document; @@ -621,8 +621,8 @@ The options are: =item C -the amount by which the current value should be modified. If the value for this option -is I then the counter will be decremented +The amount by which the current value should be modified. If the value for this option +is I then the counter will be decremented. =item C @@ -681,7 +681,7 @@ wish to do is avoid race conditions when modifying data. This functions similarly to L, and accepts an additional option, C. If the item is already locked, the server will -return a C (See L). +return a C (see L). The item is unlocked by either explicitly calling L (using the I L object passed to this method), or by @@ -700,12 +700,12 @@ Unlocking can be done implicitly: $cb->replace($doc); # Implicitly unlock -Or explicitly +Or explicitly: $cb->unlock($doc); -Locking an item twice will fail +Locking an item twice will fail: $cb->get_and_lock($doc); $cb->get_and_lock($doc); # Failure! @@ -713,7 +713,7 @@ Locking an item twice will fail Trying to modify an item without using the existing document object -will fail +will fail: $cb->get_and_lock($doc); my $newdoc = Couchbase::Document->new($doc->id, $doc->value); @@ -722,7 +722,7 @@ will fail Unlocking a non-locked item (or a different L object) -will fail +will fail: $cb->unlock($doc); # OK $cb-> @@ -746,7 +746,7 @@ associating commands with the conext, and waiting for the commands to complete. -To create a new context, use the C method +To create a new context, use the C method. =head3 batch() @@ -840,8 +840,8 @@ placeholders). The C is a set of other modifiers for the query. Most of these are sent to the server. One special parameter is the C<_host> parameter, which points to a standalone instance of the N1QL Developer Preview installation; -a temporary necesity for pre-release versions. Using of the C<_host> paramter -will be removed once Couchbase Server is available (in release or pre-release) +a temporary necessity for pre-release versions. Using of the C<_host> parameter +will be removed once the Couchbase server is available (in release or pre-release) with an integrated N1QL process. @@ -870,7 +870,7 @@ dataset into RAM. Both the C and C return L objects. This has been changed from previous versions which returned a -C object (Though the APIs remain the same). +C object (though the APIs remain the same). =head3 view_slurp("design/view", %options) @@ -937,7 +937,7 @@ details about the operation. } } -As of version 2.0.3, this method is implemented as a wrapper atop C +As of version 2.0.3, this method is implemented as a wrapper atop C. =head3 view_iterator("design/view", %options) @@ -978,7 +978,7 @@ B =head2 INFORMATIONAL METHODS These methods return various sorts of into about the cluster or specific -items +items. =head3 stats() diff --git a/lib/Couchbase/Constants.pm b/lib/Couchbase/Constants.pm index abf0769..8241e53 100644 --- a/lib/Couchbase/Constants.pm +++ b/lib/Couchbase/Constants.pm @@ -32,14 +32,14 @@ No error has ocurred. =item ETMPFAIL -A 'temporary' failure has ocurred. This usually means that the server which was +A I failure has ocurred. This usually means that the server which was the source or target of the operation (for example, a key store) was unreachable or unresponsive. =item KEY_EEXISTS An operation which required the key not to already exist was attempted, but the -key was found to have already existed +key was found to have already existed. =item KEY_ENOENT @@ -56,7 +56,7 @@ An operation was sent to the wrong server. The server which received the operati does not host the key. This error is common during failover and adding a new node to the cluster and is -generally transient +generally transient. =back diff --git a/lib/Couchbase/Document.pm b/lib/Couchbase/Document.pm index 8688102..9cb96c5 100644 --- a/lib/Couchbase/Document.pm +++ b/lib/Couchbase/Document.pm @@ -124,7 +124,7 @@ __END__ =head1 NAME -Couchbase::Document - Object represnting an item in the cluster. +Couchbase::Document - Object representing an item in the cluster =head1 SYNOPSIS @@ -138,7 +138,7 @@ Couchbase::Document - Object represnting an item in the cluster. A document is the basic unit of the API and corresponds with an item as it is stored in the cluster. A newly created document exists only locally in the application, and must be submitted to the cluster via one of the methods in -L +L. =head2 CONSTRUCTORS @@ -164,7 +164,7 @@ below. =head3 id() -Gets/Sets the ID for this document. The ID should only be set during creation +Gets or sets the ID for this document. The ID should only be set during creation of the document object. @@ -184,7 +184,7 @@ field will be updated with the value stored on the server, if successful. =head3 format($format) -Get and set the I for the item's value on the cluster. Typical +Get or set the I for the item's value on the cluster. Typical applications will not need to modify this value, but it may be desirable to use a special format for performance reasons, or to store values which are not representable in the default format. @@ -236,7 +236,7 @@ C flag is set on the scalar. Specify the expiration value to be associated with the document. This value is only read from and never written to, and is used to determine -the "Time to live" for the document. See L +the "Time to live" for the document. See L. =head2 ERROR CHECKING @@ -261,13 +261,13 @@ Some of the error codes are documented in L. =head3 errstr() Returns a textual description of the error. This should be used for -informational purposes only +informational purposes only. =head3 is_not_found() Returns true if the last operation failed because the document did not -exist on the cluster +exist on the cluster. =head3 is_cas_mismatch() diff --git a/lib/Couchbase/Settings.pm b/lib/Couchbase/Settings.pm index 922b136..8769cb9 100644 --- a/lib/Couchbase/Settings.pm +++ b/lib/Couchbase/Settings.pm @@ -133,7 +133,7 @@ The following contains a list of setting keys and their accepted values: =item C The default timeout for the library when trying to perform simple document operations. -This accepts a timeout value in seconds (fractional seconds are also allows) +This accepts a timeout value in seconds (fractional seconds are also allowed) =item C