Issue #17 new

Typo in quickstart

Chaim Krause
created an issue

I have found a typo in the quick start portion.

Existing text: {{{ Setuptools and Distribute all you to include all files checked into your version control system. }}}

Corrected text: {{{ Setuptools and Distribute allow you to include all files checked into your version control system. }}}

note: I am submitting this as an issue as an exercise for myself as I will now attempt to create a patch queue, make the change, and submit the patch as a fix.

Comments (3)

  1. Chaim Krause reporter

    I have created a patch for this issue.

    Patch "issue-17" at http://bitbucket.org/tinjaw/hgp-tinjaw

    From asking questions on #bitbucket, I was also informed that, based on project/developer preference, I might also want to include as an export. So...

    1. HG changeset patch
    2. User Chaim Krause <chaim@chaim.com>
    3. Date 1276714009 18000
    4. Node ID 67d2bb96426ebd5c654a420cb23aaadae600e4b5
    5. Parent 1f7f45263c652a3272cd48f6d594902509b095bd [mq]: issue-17

    diff -r 1f7f45263c65 -r 67d2bb96426e source/quickstart.txt --- a/source/quickstart.txt Mon May 17 08:07:57 2010 -0400 +++ b/source/quickstart.txt Wed Jun 16 13:46:49 2010 -0500 @@ -105,7 +105,7 @@ for including those files:

    • Use a package which extends Distutils with more functionality. - Setuptools and Distribute all you to include all files checked into + Setuptools and Distribute allow you to include all files checked into your version control system.
    • Write a top-level MANIFEST.in file. This is a template file which

    Please add comments to this issue. I'd like to learn this process on this small issue, so that I can contribute more widely to python projects in the future. thanx

  2. Éric Araujo

    Thanks for your help! I’m not an admin of the project but I may offer some feedback.

    There are a number of ways to submit a fix. You can attach a diff (using the “attach a file” button, not pasting in the message field, your patch earlier has been interpreted as markup and got borked), or open a fork or mq and send a pull request (with the Bitbucket button, via private email, or on IRC).

    Opening a bug is not required for simple changes. Usually, people open a bug when they don’t know how to fix it, or if they don’t have time to work on a patch right now and don’t want to forget. If you spot typos or simple bugs, you cant just commit a fix in your repo an ask for a pull.

    If you’re interested long-term in the packaging guide, you may join http://groups.google.com/group/packaging-guide (open, but requires a Google account). If not, it’s okay, thanks for the patch! :)

  3. Log in to comment