Opened 10 years ago
Closed 10 years ago
#24907 closed Cleanup/optimization (fixed)
Update the contributing tutorial to use a more recent patch
Reported by: | Markus Amalthea Magnuson | Owned by: | Markus Amalthea Magnuson |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
There is a slight difference between the two example command lines for running all Django tests on this page:
PYTHONPATH=..:$PYTHONPATH ./runtests.py
and this page:
PYTHONPATH=.. python runtests.py --settings=test_sqlite
I think one should be changed to the other for consistency. I'd prefer the first one since it includes any existing Python path and omits SQLite which is already the default, which might even change in the future.
Change History (6)
comment:1 by , 10 years ago
comment:2 by , 10 years ago
I think updating the tutorial using a newer ticket would be a good idea, and I'd be up for doing it.
Should it ideally be similar to the previous one, or something different? I'm assuming it should also be a closed and fixed one :)
Was the previous one taking its diffs etc. from the actual patch that went into the code base?
comment:3 by , 10 years ago
Summary: | Command line for running all tests are slightly different on Unit tests and Writing your first patch pages → Update the contributing tutorial to use a more recent patch |
---|---|
Triage Stage: | Unreviewed → Accepted |
Yes, a good candidate might be 4df7e8483b2679fc1cba3410f08960bac6f51115. Feel free to suggest something else.
comment:4 by , 10 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
Thanks a lot, will have a go at this in the next couple of days, based on that commit/ticket.
comment:5 by , 10 years ago
Has patch: | set |
---|
Opened pull request: https://github.com/django/django/pull/4787
The issue is that the point in Django's history that the tutorial uses requires
--settings=test_sqlite
. Of course, we could make a new tutorial that uses a more recent patch as an example.I think
PYTHONPATH=..
might be a little safer in case you have Django installed globally but I'm not sure if we should prefer one or the other.