Doc: clean up markup for jsonb_set and related functions.
authorTom Lane
Fri, 27 Sep 2019 15:01:36 +0000 (11:01 -0400)
committerTom Lane
Fri, 27 Sep 2019 15:01:47 +0000 (11:01 -0400)
The markup for optional parameters was neither correct nor consistent.
In passing, fix a spelling mistake.

Per report from Alex Macy.  Some of these mistakes are old, so
back-patch as appropriate.

Discussion: https://postgr.es/m/156953522258.1204.12736099368284950578@wrigleys.postgresql.org

doc/src/sgml/func.sgml

index 48df9f869a788ad65adc49c569087eff1a13c406..0aa399dc2f00a90a91028b9c4f969a5bbe739543 100644 (file)
@@ -12497,7 +12497,7 @@ table2-mapping
        [{"f1":1},2,null,3]
        
       
-       jsonb_set(target jsonb, path text[], new_value jsonbcreate_missing boolean)
+       jsonb_set(target jsonb, path text[], new_value jsonb , create_missing boolean)
          
        jsonb
        
@@ -12505,10 +12505,10 @@ table2-mapping
          with the section designated by path
          replaced by new_value, or with
          new_value added if
-         create_missing is true ( default is
+         create_missing is true (default is
          true) and the item
          designated by path does not exist.
-         As with the path orientated operators, negative integers that
+         As with the path oriented operators, negative integers that
          appear in path count from the end
          of JSON arrays.
        
@@ -12522,7 +12522,7 @@ table2-mapping
       
        
            
-           jsonb_insert(target jsonb, path text[], new_value jsonbinsert_after boolean)
+           jsonb_insert(target jsonb, path text[], new_value jsonb , insert_after boolean)
            
        
        jsonb
@@ -12537,7 +12537,7 @@ table2-mapping
          designated by path is in JSONB object,
          new_value will be inserted only if
          target does not exist. As with the path
-         orientated operators, negative integers that appear in
+         oriented operators, negative integers that appear in
          path count from the end of JSON arrays.
        
        
@@ -12578,10 +12578,10 @@ table2-mapping
        
         
          
-           jsonb_path_exists(target jsonb, path jsonpath [, vars jsonb [, silent bool]])
+           jsonb_path_exists(target jsonb, path jsonpath , vars jsonb , silent bool)
          
          
-           jsonb_path_exists_tz(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_exists_tz(target jsonb, path jsonpath , vars jsonb , silent bool)
          
         
         boolean
@@ -12601,10 +12601,10 @@ table2-mapping
        
         
          
-           jsonb_path_match(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_match(target jsonb, path jsonpath , vars jsonb , silent bool)
          
          
-           jsonb_path_match_tz(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_match_tz(target jsonb, path jsonpath , vars jsonb , silent bool)
          
         
         boolean
@@ -12625,10 +12625,10 @@ table2-mapping
        
         
          
-           jsonb_path_query(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query(target jsonb, path jsonpath , vars jsonb , silent bool)
          
          
-           jsonb_path_query_tz(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query_tz(target jsonb, path jsonpath , vars jsonb , silent bool)
          
         
         setof jsonb
@@ -12656,10 +12656,10 @@ table2-mapping
        
         
          
-           jsonb_path_query_array(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query_array(target jsonb, path jsonpath , vars jsonb , silent bool)
          
          
-           jsonb_path_query_array_tz(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query_array_tz(target jsonb, path jsonpath , vars jsonb , silent bool)
          
         
         jsonb
@@ -12679,10 +12679,10 @@ table2-mapping
        
         
          
-           jsonb_path_query_first(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query_first(target jsonb, path jsonpath , vars jsonb , silent bool)
          
          
-           jsonb_path_query_first_tz(target jsonb, path jsonpath [, vars jsonb, silent bool])
+           jsonb_path_query_first_tz(target jsonb, path jsonpath , vars jsonb , silent bool)
          
         
         jsonb