Mercurial > p > roundup > code
annotate doc/index.txt @ 7752:b2dbab2b34bc
fix(refactor): multiple fixups using ruff linter; more testing.
Converting to using the ruff linter and its rulesets. Fixed a number
of issues.
admin.py:
sort imports
use immutable tuples as default value markers for parameters where a
None value is valid.
reduced some loops to list comprehensions for performance
used ternary to simplify some if statements
named some variables to make them less magic
(e.g. _default_savepoint_setting = 1000)
fixed some tests for argument counts < 2 becomes != 2 so 3 is an
error.
moved exception handlers outside of loops for performance where
exception handler will abort loop anyway.
renamed variables called 'id' or 'dir' as they shadow builtin
commands.
fix translations of form _("string %s" % value) -> _("string %s") %
value so translation will be looked up with the key before
substitution.
end dicts, tuples with a trailing comma to reduce missing comma
errors if modified
simplified sorted(list(self.setting.keys())) to
sorted(self.setting.keys()) as sorted consumes whole list.
in if conditions put compared variable on left and threshold condition
on right. (no yoda conditions)
multiple noqa: suppression
removed unneeded noqa as lint rulesets are a bit different
do_get - refactor output printing logic: Use fast return if not
special formatting is requested; use isinstance with a tuple
rather than two isinstance calls; cleaned up flow and removed
comments on algorithm as it can be easily read from the code.
do_filter, do_find - refactor output printing logic. Reduce
duplicate code.
do_find - renamed variable 'value' that was set inside a loop. The
loop index variable was also named 'value'.
do_pragma - added hint to use list subcommand if setting was not
found. Replaced condition 'type(x) is bool' with 'isinstance(x,
bool)' for various types.
test_admin.py
added testing for do_list
better test coverage for do_get includes: -S and -d for multilinks,
error case for -d with non-link.
better testing for do_find including all output modes
better testing for do_filter including all output modes
fixed expected output for do_pragma that now includes hint to use
pragma list if setting not found.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 01 Mar 2024 14:53:18 -0500 |
| parents | a072331c843b |
| children | e3b34d02c61a |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
1 .. meta:: |
|
6774
e7b4ad2c57ac
landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
2 :description: |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
3 Table of contents for documentation on the Roundup Issue Tracker. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
4 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
5 ======================================================= |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
6 Roundup: an Issue-Tracking System for Knowledge Workers |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 ======================================================= |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
6160
diff
changeset
|
9 For how to contact the community see https://www.roundup-tracker.org . |
|
4610
e793eafba69c
Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents:
4440
diff
changeset
|
10 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 Contents |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 ======== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
14 .. toctree:: |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
15 :maxdepth: 2 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
17 features |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
18 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
19 installation |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
20 upgrading |
| 7092 | 21 security |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
22 FAQ |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
23 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
24 user_guide |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
25 |
|
7499
a072331c843b
Change customizing to customising in all variants.
John Rouillard <rouilj@ieee.org>
parents:
7331
diff
changeset
|
26 customising <customizing.txt> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
27 rest |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
28 xmlrpc |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
29 reference |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
30 glossary |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
31 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
32 admin_guide |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
33 license |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
34 acknowledgements |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
35 |
|
7283
1a0548b60c6b
Update document TOC with security-history, reference, upgrading-history
John Rouillard <rouilj@ieee.org>
parents:
7100
diff
changeset
|
36 upgrading-history |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
37 |
|
7100
8a267e9827cc
Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents:
7096
diff
changeset
|
38 tracker_templates |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
39 |
|
7100
8a267e9827cc
Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents:
7096
diff
changeset
|
40 Design Overview <overview> |
|
4890
609edf9de0a5
docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents:
4746
diff
changeset
|
41 Design (original) <design> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
42 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
43 developers |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
44 |
|
5078
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
45 Notes about the MySQL Database backend <mysql> |
|
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
46 Notes about the PostgreSQL Database backend <postgresql> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
47 |
|
5078
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
48 Richard Jones implementation notes <implementation> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
49 security-history |
|
5925
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
50 |
|
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
51 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to |
|
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
52 documentation. |
|
6160
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
53 |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
54 Indices |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
55 ======= |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
56 |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
57 * :ref:`genindex` |
