Opened 7 years ago

Closed 6 years ago

Last modified 5 years ago

#13662 closed (fixed)

Documentation for running tests difficult to find

Reported by: Michael Radziej Owned by: Greg Turner
Component: Documentation Version: 1.2
Severity: Keywords: sprintdec2010
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Somebody who just wants to run the django testsuite (and not actually contribute) will probably not look up "how to contribute" in the django docs, so he cannot find the documentation on how to run the testsuite. Please provide a simple explanation or refer to the docs in the toplevel README (as long as we cannot do a "setup.py test")

Attachments (3)

running_tests_docs.diff (5.4 KB) - added by Greg Turner 6 years ago.
13662.diff (2.4 KB) - added by Gabriel Grant 6 years ago.
additional changes to the original patch
13662.combined.diff (5.6 KB) - added by Gabriel Grant 6 years ago.
this patch contains all the changes from the above two patches, as well as a few extra line-length fixes

Download all attachments as: .zip

Change History (16)

comment:1 Changed 6 years ago by Russell Keith-Magee

milestone: 1.3
Triage Stage: UnreviewedAccepted

Agreed; it's generally good practice to document how to run the tests as part of your README (or at least to provide a link to where such instructions are documented).

comment:2 Changed 6 years ago by Greg Turner

Owner: changed from nobody to Greg Turner
Status: newassigned

Patch attached and at https://github.com/cogat/django/commit/16e0b83c1ea18d9a5fab8bff4f7e754022c4d6f4.

I also updated the running tests documentation to be clearer and make it easier to get started.

comment:3 Changed 6 years ago by Greg Turner

Keywords: sprintdec2010 added

Changed 6 years ago by Greg Turner

Attachment: running_tests_docs.diff added

comment:5 Changed 6 years ago by Gabriel Grant

Has patch: set

mostly looks good to me, spare a few little things:

I believe link on README line 44 should read:
http://docs.djangoproject.com/en/dev/internals/contributing/#running-the-unit-tests
(note the changed anchor)

I'm a bit concerned about telling people to install by manually putting this version in site-packages (docs/internals/contributing.txt, line 894). For the quick start, I've suggested simply symlinking django into the test directory (as well as pointed them to to the other options).

As an aside, these instructions could probably use to be updated (pip, anyone?)

I've uploaded a patch with the adding the new changes.

Changed 6 years ago by Gabriel Grant

Attachment: 13662.diff added

additional changes to the original patch

comment:6 Changed 6 years ago by Greg Turner

I agree with all of gg's suggestions.

comment:8 Changed 6 years ago by Gabriel Grant

Triage Stage: AcceptedReady for checkin

cogat's final version is RFC

Changed 6 years ago by Gabriel Grant

Attachment: 13662.combined.diff added

this patch contains all the changes from the above two patches, as well as a few extra line-length fixes

comment:9 Changed 6 years ago by Gabriel Grant

Owner: Greg Turner deleted
Status: assignednew

comment:10 Changed 6 years ago by Gabriel Grant

Owner: set to Greg Turner

comment:11 Changed 6 years ago by Russell Keith-Magee

Resolution: fixed
Status: newclosed

(In [15342]) Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text.

comment:12 Changed 6 years ago by Russell Keith-Magee

(In [15345]) [1.2.X] Fixed #13662 -- Added an entry in the README to direct people to the instructions for running the test suite, and cleaned up that section of the docs. Thanks to mir for the report, and to cogat and gg for the draft text.

Backport of r15342 from trunk.

comment:13 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top