Re: [RFC/PATCH] Git.pm: discourage casual use

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Dec 2, 2010, 19:45 UTC
Message-ID: <20101202194536.GB4806@burratino>
In-Reply-To: <7veia0q8fx.fsf@alter.siamese.dyndns.org>

Junio C Hamano wrote:

> Jonathan Nieder <jrnieder@gmail.com> writes:

>> So how about something like this patch, to start?
>
> Ok.  We may probably want to reduce the repetition of "easy", though.

Yes. ---

diff --git a/perl/Git.pm b/perl/Git.pm
index 69e92aa..4700dd7 100644
--- a/perl/Git.pm
+++ b/perl/Git.pm
@@ -65,12 +65,12 @@ require Exporter;
 
 This module provides an easy way to interact with the Git version control
 system for Git's internal perl scripts.
-The modules have an easy and well-tested way to call arbitrary Git
-commands; in the future, the interface will also provide specialized methods
-for doing easily operations which are not totally trivial to do over
+The modules include a robust way to call arbitrary Git commands;
+in the future, the interface will also provide specialized methods
+to simplify operations which are not totally trivial to do over
 the generic command interface.
 
-Note: this module should not be used by code outside the Git package itself,
+The module should not be used by code outside the Git package itself,
 since the API is not stable yet.
 
 While some commands can be executed outside of any context (e.g. 'version'