From c8e8b2f9dfee21fa4ef1ec7da5c10e6ef706df36 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Tue, 10 Mar 2020 17:34:01 -0400 Subject: Marginal comments and docs cleanup. Fix up some imprecise comments and poor markup from ba79cb5dc. Also try to convert the documentation of log_min_duration_sample and friends into passable English. --- src/backend/nodes/params.c | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'src/backend/nodes/params.c') diff --git a/src/backend/nodes/params.c b/src/backend/nodes/params.c index b28ec3b6ce4..a57f9eea768 100644 --- a/src/backend/nodes/params.c +++ b/src/backend/nodes/params.c @@ -262,16 +262,16 @@ RestoreParamList(char **start_address) /* * BuildParamLogString - * Return a string that represent the parameter list, for logging. + * Return a string that represents the parameter list, for logging. * * If caller already knows textual representations for some parameters, it can * pass an array of exactly params->numParams values as knownTextValues, which * can contain NULLs for any unknown individual values. NULL can be given if * no parameters are known. * - * If maxlen is not zero, that's the maximum number of characters of the - * input string printed; an ellipsis is added if more characters exist. - * (Added quotes are not considered.) + * If maxlen is not zero, that's the maximum number of bytes of any one + * parameter value to be printed; an ellipsis is added if the string is + * longer. (Added quotes are not considered in this calculation.) */ char * BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen) @@ -282,7 +282,8 @@ BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen) /* * NB: think not of returning params->paramValuesStr! It may have been - * generated with a different maxlen, and so unsuitable. + * generated with a different maxlen, and so be unsuitable. Besides that, + * this is the function used to create that string. */ /* -- cgit v1.2.3