Skip to content

Commit be0d9f8

Browse files
committed
doc: clean table for "the request variable"
alphabetize the keys, also remove second form key from first table.
1 parent 9c5c8b3 commit be0d9f8

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

doc/reference.txt

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3393,13 +3393,12 @@ request.
33933393
=========== ============================================================
33943394
Variable Holds
33953395
=========== ============================================================
3396-
form the CGI form as a cgi.FieldStorage
3397-
env the CGI environment variables
33983396
base the base URL for this tracker
3399-
user a HTMLUser instance for this user
34003397
classname the current classname (possibly None)
3398+
env the CGI environment variables
3399+
form the current CGI form variables in a cgi.FieldStorage
34013400
template the current template (suffix, also possibly None)
3402-
form the current CGI form variables in a FieldStorage
3401+
user a HTMLUser instance for this user
34033402
=========== ============================================================
34043403

34053404
**Index page specific variables (indexing arguments)**
@@ -3408,30 +3407,30 @@ form the current CGI form variables in a FieldStorage
34083407
Variable Holds
34093408
=========== ============================================================
34103409
columns dictionary of the columns to display in an index page
3411-
show a convenience access to columns - request/show/colname will
3412-
be true if the columns should be displayed, false otherwise
3413-
sort index sort columns [(direction, column name)]
3414-
group index grouping properties [(direction, column name)]
34153410
filter properties to filter the index on
34163411
filterspec values to filter the index on (property=value, eg
34173412
``priority=1`` or ``messages.author=42``
3413+
group index grouping properties [(direction, column name)]
34183414
search_text text to perform a full-text search on for an index
3415+
show a convenience access to columns - request/show/colname will
3416+
be true if the columns should be displayed, false otherwise
3417+
sort index sort columns [(direction, column name)]
34193418
=========== ============================================================
34203419

34213420
There are several methods available on the request variable:
34223421

34233422
=============== ========================================================
34243423
Method Description
34253424
=============== ========================================================
3426-
description render a description of the request - handle for the
3427-
page title
3428-
indexargs_form render the current index args as form elements
3429-
indexargs_url render the current index args as a URL
34303425
base_javascript render some javascript that is used by other components
34313426
of the templating
34323427
batch run the current index args through a filter and return a
34333428
list of items (see `hyperdb item wrapper`_, and
34343429
`batching`_)
3430+
description render a description of the request - handle for the
3431+
page title
3432+
indexargs_form render the current index args as form elements
3433+
indexargs_url render the current index args as a URL
34353434
=============== ========================================================
34363435

34373436
The form variable

0 commit comments

Comments
 (0)