[tools] testbot/cgi: Improve the CollectionBlock::GetDetailsLink() documentation.

Francois Gouget fgouget at codeweavers.com
Tue May 3 12:38:21 CDT 2022


Specifically, better document the escaping situation.

Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
---
 testbot/lib/ObjectModel/CGI/CollectionBlock.pm | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/testbot/lib/ObjectModel/CGI/CollectionBlock.pm b/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
index b2ebb2eec..594ed5649 100644
--- a/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
+++ b/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
@@ -200,6 +200,10 @@ sub GetSortedItems($$)
 
 Returns the URL of the details page for the current row's object.
 
+If the URL contains parameters those must already be encoded (see uri_escape())
+but the returned URL as a whole may still need to be escaped for use in HTML
+documents (notably for the ampersands, see escapeHTML()).
+
 See GenerateDataView() for details about the Row parameter.
 
 =back
-- 
2.30.2



More information about the wine-devel mailing list