Commit Graph

204 Commits

Author SHA1 Message Date
Sean Wang eba6dff581 Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
Tim Graham d28bcba209 Fixed typo in docs/internals/contributing/triaging-tickets.txt 2015-02-20 07:26:16 -05:00
Tim Graham dbacbc729a Simplified and updated committing code guidelines. 2015-02-19 20:36:24 -05:00
Tim Graham 0adf766e16 Fixed #23811 -- Added a guide for using git bisect. 2015-02-19 20:18:52 -05:00
Tim Graham 7cf3a5786b Updated docs and runtests.py for removal of tests from contrib. 2015-02-11 10:29:54 -05:00
Tim Graham a3473454ad Updated docs on running selenium tests. 2015-02-10 12:30:28 -05:00
Tim Graham 6704b52980 Fixed #24269 -- Added docs about the process of managing translations in Django. 2015-02-09 13:07:45 -05:00
Peter Inglesby a8f1c70dce Fixed docs typo 2015-02-07 18:46:04 +01:00
wrwrwr cd155c7c71 Fixed #23860 -- Documented import order convention. 2015-02-06 14:48:56 -05:00
Riccardo Magliocchetti 9410d69835 Added cross references to contributing docs. 2015-02-05 10:40:46 -05:00
darkryder 9ec8aa5e5d Fixed #24149 -- Normalized tuple settings to lists. 2015-02-03 14:59:45 -05:00
Tim Graham c79faae761 Removed versionadded/changed notes for 1.7. 2015-02-01 21:02:40 -05:00
Tim Graham 63412262e5 Fixed #24175 -- Updated docstring convention. 2015-01-29 12:21:44 -05:00
Marc Tamlyn b5c1a85b50 Fixed #24118 -- Added --debug-sql option for tests.
Added a --debug-sql option for tests and runtests.py which outputs the
SQL logger for failing tests. When combined with --verbosity=2, it also
outputs the SQL for passing tests.

Thanks to Berker, Tim, Markus, Shai, Josh and Anssi for review and
discussion.
2015-01-12 08:16:08 +00:00
Tim Graham 7102b99653 Added best practices for versionadded/changed annotations. 2015-01-09 13:23:29 -05:00
Claude Paroz 66f9a74b45 Added ignore_warnings decorator
And removed Ignore*DeprecationWarningsMixin, now obsolete.
Thanks Berker Peksag and Tim Graham for the review.
2014-12-30 18:16:25 +01:00
Tim Graham 6571ed14b6 Fixed #24049 -- Removed obsolete Java notes for Mac OS. 2014-12-24 18:38:07 -05:00
Tim Graham 82e4f956e3 Fixed #23289 -- Added mock as a test dependency. 2014-12-01 16:08:25 -05:00
Tim Graham 3131e9cef5 Fixed #23923 -- Promoted Django's deprecation warnings to errors in runtests.py 2014-11-29 10:27:04 -05:00
wrwrwr e22c64dfc0 Fixed #23742 -- Added an option to reverse tests order.
This is useful for debugging side effects affecting tests that
are usually executed before a given test. Full suite and pair
tests sort cases more or less deterministically, thus some test
cross-dependencies are easier to reveal by reversing the order.

Thanks Preston Timmons for the review.
2014-11-24 19:24:11 -05:00
wrwrwr ca801b8c8f Improved line breaking in runtests docs. 2014-11-24 17:38:28 -05:00
Erik Romijn de912495ab Added reminder to committing docs to test a PR with Jenkins first. 2014-11-16 13:32:40 +01:00
wrwrwr f9213a85c3 Fixed #23775 -- Added docs for --bisect and --pair runtests options.
Thanks Baptiste Mispelon for review.
2014-11-12 20:46:34 +01:00
Berker Peksag 22c85bf1a8 Fixed versionchanged indentation in unit-tests.txt. 2014-10-23 08:03:41 -04:00
Berker Peksag 303a848631 Fixed IRC channel name in submitting-patches.txt.
The development channel is #django-dev.
2014-10-16 16:56:37 +03:00
Corey Farwell 37b13033c6 Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
Tim Graham 1101467ce0 Limited lines to 119 characters in django/
refs #23395.
2014-09-05 09:22:16 -04:00
Erik Romijn 2154004802 Fixed tiny commit style inconsistency in committing code documentation. 2014-08-27 09:18:56 +02:00
Duncan Parkes 905c4fdcc3 Fixed clone URL of Django git repository. 2014-08-26 20:48:12 -04:00
Tim Graham fca677fa43 Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
Tim Graham 0efd72dc90 Fixed broken links in docs. 2014-08-05 08:23:34 -04:00
Aymeric Augustin a4ead67ee9 Adjusted 'internals' docs to the new organization.
Most of these changes are about using the correct vocabulary -- "core
team member" vs "core developer/committer" and adding internal links.
2014-08-01 14:41:25 +02:00
Aymeric Augustin dd9c8f9382 Left formal decisions up to the technical board.
As the core team grows towards 50 people, it isn't reasonable to give
everyone veto rights anymore.
2014-08-01 14:41:24 +02:00
Aymeric Augustin 4a475ce1c8 Introduced a technical board.
Extended the scope of the core team a bit (depending on your current
perspective on that scope).
2014-08-01 14:41:24 +02:00
Aymeric Augustin e9fde1c7ec Removed references to partial commit acces. 2014-08-01 14:41:24 +02:00
Aymeric Augustin 5ad48a9ef2 Renamed "committers" to "team". 2014-08-01 14:41:24 +02:00
Petras Zdanavičius 5a311d2ccc Fixed #23103 -- Added contributing tutorial link to contributing index. 2014-07-26 09:50:05 -04:00
Iain Dawson 8fbf13a6c8 Replaced instances of 'his/her' with 'their'. 2014-07-21 19:49:12 +00:00
Tim Graham dd6ef3197a Fixed #23015 -- Fixed major/minor release terminology in docs. 2014-07-13 13:37:56 -04:00
Tim Graham 1a3bec4a26 Fixed #18108 -- Added instructions for translating documentation.
Thanks Claude Paroz.
2014-07-02 13:16:31 -04:00
Tim Graham bcc3d2b978 Fixed #22818 -- Clarified you need to cd into the Django clone.
Thanks Josh Parris.
2014-06-12 10:19:03 -04:00
Tim Graham 61960dd02c Added a patch review checklist. 2014-06-03 11:55:17 -04:00
Aymeric Augustin 8b5b199e20 Fixed #3214 -- Stopped parsing SQL with regex.
Avoided introducing a new regex-based SQL splitter in the migrations
framework, before we're bound by backwards compatibility.

Adapted this change to the legacy "initial SQL data" feature, even
though it's already deprecated, in order to facilitate the transition
to migrations.

sqlparse becomes mandatory for RunSQL on some databases (all but
PostgreSQL). There's no API to provide a single statement and tell
Django not to attempt splitting. Since we have a more robust splitting
implementation, that seems like a good tradeoff. It's easier to add a
new keyword argument later if necessary than to remove one.

Many people contributed to both tickets, thank you all, and especially
Claude for the review.

Refs #22401.
2014-04-26 17:46:23 +02:00
Claude Paroz 7c24027bad Renamed Transifex project from django-core to django
See also http://blog.transifex.com/post/83622601443/new-teams-management-transifex
2014-04-24 11:38:18 +02:00
Marti Raudsepp 11d453bcad Various documentation typo/spelling fixes
Errors detected by Topy (https://github.com/intgr/topy), all changes
verified by hand.
2014-04-23 02:31:49 +03:00
Tim Graham 47927eb786 Revert "Fixed #22401 -- Deprecated regular expression parsing of initial SQL in favor of installing sqlparse."
This reverts commit 071c933775.

This introduced a regression on MySQL and custom SQL is deprecated.
2014-04-16 21:03:22 -04:00
Jordi Yeh 2810299117 Fixed #22457 -- Fixed contributing guide w/o github set-up
The published commnand was not working when the user did not have
the git client set-up with the public-key. Changed the contributing
guide to clone it from https instead.
2014-04-16 09:33:53 -04:00
julien 'pouete' Godin 071c933775 Fixed #22401 -- Deprecated regular expression parsing of initial SQL in favor of installing sqlparse. 2014-04-09 19:25:07 -04:00
Anubhav Joshi 0399523cf1 Fixed #22253 -- Added django-i18n to the mailing lists docs.
Thanks bmispelon for the suggestion.
2014-03-19 07:22:01 -04:00
Anubhav Joshi abade6413b Fixed #21991 -- Added warning regarding tests failure if locales not installed.
Thanks reidrac for the report.
2014-03-16 14:34:18 -04:00
Claude Paroz 210d0489c5 Fixed #21188 -- Introduced subclasses for to-be-removed-in-django-XX warnings
Thanks Anssi Kääriäinen for the idea and Simon Charette for the
review.
2014-03-08 09:57:40 +01:00
Szczepan Cieślik a0f2525202 Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
Rodolfo Carvalho 2b6436e2d5 Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
Tim Graham 1f5f015c32 Fixed spelling mistakes in docs. 2014-02-28 21:03:46 -05:00
Tim Graham 7f2505ad9e Fixed doc typos. 2014-02-28 11:44:03 -05:00
Martin Matusiak d399731bf2 Fixed #22007 -- Fixed cbv docs - make imports consistent
Thanks to trac user kinjal.dixit for the report.
2014-02-22 14:39:09 +01:00
Adrian Holovaty 660b7e7000 Removed BDFL stuff from docs/internals/contributing/bugs-and-features.txt 2014-01-13 10:32:09 -06:00
Tim Graham 9953e98e6a Fixed #21701 -- Improved testing doc titles and added testing/tools.txt.
Thanks cjerdonek for the suggestion.
2013-12-31 08:14:09 -05:00
Yaroslav Halchenko 80027d2c38 Unified listing of shell commands/code
- use code-block:: bash
- prefix the command with $
2013-12-25 15:19:14 -05:00
Aymeric Augustin 9b8192ce51 Updated a few doc paragraphs following the app-loading refactor. 2013-12-24 17:20:11 +01:00
Bouke Haarsma bed52afee7 Removed usage of to-be-deprecated ADMIN_FOR setting in contributing docs 2013-12-14 16:49:25 +01:00
Simon Charette c047dda057 Removed an erroneous leading slash introduced by a626bdf648a. 2013-12-08 13:18:53 -05:00
Claude Paroz 626bdf648a Updated a bunch of hyperlinks in documentation 2013-12-08 18:40:09 +01:00
Alasdair Nicol c75dd664cf Fixed #21538 -- Added numpy to test/requirements/base.txt
Thanks Tim Graham for the report
2013-12-02 13:37:59 -05:00
Alex Gaynor c0a2daad78 Documented the house style for gender neutral pronouns. 2013-11-30 08:31:58 -05:00
Cody Scott 4a54b69e88 Fixed sentence structure in docs/internals/contributing/triaging-tickets.txt 2013-11-22 09:07:10 -05:00
Tim Graham 98de90d3d8 Fixed spelling of compatibility. 2013-11-09 10:17:17 -05:00
Tim Graham 14c1872d29 Recommended flake8 to check coding style. 2013-11-09 06:39:55 -05:00
Claude Paroz e953c78eeb Fixed #16969 -- Don't connect to named database when possible
Thanks Andreas Pelme for the report and initial patch, and
Aymeric Augustin, Shai Berger and Tim Graham for the reviews.
2013-11-09 09:42:17 +01:00
Tim Graham c573d6de17 Fixed #19941 -- Removed sys.path hack when running the test suite.
Thanks jezdez for the suggestion.
2013-10-23 18:27:06 -04:00
Tim Graham 1dae4ac177 Whitespace cleanup.
* Removed trailing whitespace.
* Added newline to EOF if missing.
* Removed blank lines at EOF.
* Removed some stray tabs.
2013-10-10 16:49:20 -04:00
Tim Graham 9700194195 Fixed #21222 - Documented that 'default' and 'other' must be different databases when running tests.
Thanks vernondcole for the suggestion.
2013-10-09 11:42:27 -04:00
Unai Zalakain 3895d8899d Fixed #21213 -- Added docs for Django's mailing lists.
Added docs/internals/mailing-lists.txt documenting the use of django's
mailing lists. All references across docs changed to point to this page.

The referencing makes use of substitution because there's no way to make
a :ref: link in a non-inline fashion in Sphinx. It also makes use of
rst_epilog Sphinx conf for making this substitutions across all the
docs.
2013-10-04 10:00:36 -04:00
Baptiste Mispelon 42b9feb2e7 Fixed wording in unit tests documentation. 2013-09-25 18:24:30 +02:00
Rogério Yokomizo 1b4b710355 Fixed #21141 -- Update Sphinx URL
Updated Sphinx URL from http://sphinx.pocoo.org/ to http://sphinx-doc.org/.
2013-09-22 14:44:09 -03:00
Tim Graham 5be56d0e0d Fixed #21024 -- Documented how to deprecate a feature. 2013-09-17 13:23:32 -04:00
Kevin Christopher Henry 990ce9aab9 Documentation -- added instructions on working with pull requests
Since non-core contributors are asked to review patches, instructions
on working with pull requests were added to the Working with Git and
GitHub page (based on the existing instructions in the core
committers page).
2013-09-13 08:26:46 -04:00
Tim Graham cd4068f359 Fixed instructions for running a subset of tests. 2013-09-06 14:31:27 -04:00
Eric Boersma 4d13cc56de Fixed #21035 -- Changed docs to treat the acronym SQL phonetically.
The documentation and comments now all use 'an' to
refer to the word SQL and not 'a'.
2013-09-05 20:14:58 -04:00
micahhausler 93dd31cadf Fixed #21047 -- Added CLA mesage on the new contributor advice doc 2013-09-05 17:52:36 -04:00
Matt Robenolt 08e7a64369 Updated instructions for running contrib tests. 2013-08-27 08:21:42 -04:00
Andrew Godwin b6a957f0ba Merge remote-tracking branch 'core/master' into schema-alteration
Conflicts:
	docs/ref/django-admin.txt
2013-08-19 18:30:48 +01:00
Daniele Procida e868eaf680 clarified misleading wording about squashing commits 2013-08-10 22:24:24 +01:00
Andrew Godwin de64c4d6e9 Merge remote-tracking branch 'core/master' into schema-alteration
Conflicts:
	django/core/management/commands/flush.py
	django/core/management/commands/syncdb.py
	django/db/models/loading.py
	docs/internals/deprecation.txt
	docs/ref/django-admin.txt
	docs/releases/1.7.txt
2013-08-09 14:17:30 +01:00
Andrew Godwin f8297f6323 More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
Anssi Kääriäinen b2314d9e1e Fixed #19941 -- Modified runtests.py to make running the tests easier.
1. Automatically use tests/../django as the Django version.
2. If settings aren't provided through --settings or DJANGO_SETTINGS_MODULE)
   then use test_sqlite.
2013-07-24 07:33:03 -04:00
Tim Graham 77856dc875 Added some missing test requirements in the docs; refs #19196 2013-07-10 12:01:17 -04:00
Tim Graham 4d92a0bd86 Fixed #19196 -- Added test/requirements 2013-07-10 09:24:05 -04:00
Jeremy Dunck 9aed3201aa Clarified trac patch-related field meaning
There was some confusion on the mentorship list as to whether 'needs tests'
meant that a given ticket might not need tests, as opposed to flagging
a specific patch as still needing tests.

This commit seeks to clarify that confusion.
2013-07-07 21:17:10 -07:00
Claude Paroz 7442eb1a24 Fixed #20224 -- Update docs examples which mention __unicode__
Thanks Marc Tamlyn and Tim Graham for the review.
2013-07-05 19:27:07 +02:00
SusanTan b0907d66a5 Fixed #20524 - Described keywords in triaging contrib doc. 2013-06-23 15:41:24 -04:00
russkel f80b1063e4 Update submitting-patches.txt
Few quick fixes to the terminology in order to match what is used on the Django Trac at the moment.
2013-06-08 14:53:27 +09:00
Tim Graham 490672f057 Tweaked unit test 'quick start' explanation.
Thanks Jeremy Dunck.
2013-05-20 13:45:32 -04:00
Aymeric Augustin a9b98f59aa Clarified when triagers should close tickets as needsinfo.
https://groups.google.com/d/msg/django-developers/dyldP9kFADc/rHTlRBVEP8MJ
2013-05-19 15:24:10 +02:00
Claude Paroz 8f7276b782 Updated Transifex links to the Django project
Translations for the Django framework are now hosted on the
django-core Transifex project, and the django project is only
dedicated to a team-only hub project.
2013-04-25 10:35:51 +02:00
Juan Catalano 4e25198ec2 Fixed #20104 -- Changed VersionDirective in order to avoid ambiguity.
As explained in ticket #20104, the use of versionchanged/versionadded
was confusing.

To solve this ambiguity these directives no longer accept a second
argument but now they only receive the version number (1st arg) and then
a content with the proper comment.
2013-04-20 17:18:21 +02:00
Julien Phalip 68d6c52ed6 Turned the triage attributes to actual sections so they can be more easily linked to in the documentation. 2013-04-10 17:11:26 -07:00
Preston Holmes 18255779e9 Added some further guidance to "accepted" triage stage
Now that DDN is gone, I felt it was worth some extra language
about what "accepted" means, and qualify what it means to be "safe"
to start writing a patch.
2013-04-09 22:39:36 -07:00
Aymeric Augustin 4a7292df3b Removed references to the DDN triage state.
Rephrased "How can I help with triaging?" a bit to reflect the current
practice.
2013-04-08 20:33:52 +02:00
Florian Apolloner 28e545c4b3 Updated docs to reflect new tests layout.
Thanks to Ramiro Morales for the initial patch.
2013-02-26 15:00:16 +01:00