pgr_bipartite: updating documentation

Author: cvvergara

doc/coloring/coloring-family.rst

@@ -65,6 +65,22 @@ Column           Type        Description
 
 .. result-edge-color-end
 
+.. result-node-color-start
+
+Returns set of |result_node_color|
+
+============  =========== =====================================
+Column           Type        Description
+============  =========== =====================================
+``node``      ``BIGINT``  Identifier of the node.
+``color``     ``BIGINT``  Color of the node.
+
+                          - The minimum value of color is 1.
+
+============  =========== =====================================
+
+.. result-node-color-end
+
 .. result columns start
 
 Returns set of ``(vertex_id, color_id)``

doc/coloring/pgr_bipartite.rst

@@ -25,9 +25,13 @@ the same set are adjacent.
 
 .. rubric:: Availability
 
-* Version 3.2.0
+.. rubric:: Version 4.0.0
 
-  * New experimental function.
+* Output columns standardized to |result-node-color|
+
+.. rubric:: Version 3.2.0
+
+* New experimental function.
 
 Description
 -------------------------------------------------------------------------------
@@ -86,8 +90,8 @@ Result columns
 -------------------------------------------------------------------------------
 
 .. include:: coloring-family.rst
-    :start-after: result columns start
-    :end-before: result columns end
+    :start-after: result-node-color-start
+    :end-before: result-node-color-end
 
 Additional Example
 --------------------------------------------------------------------------------

doc/conf.py.in

@@ -365,6 +365,7 @@ rst_epilog="""
 .. |result-1-1-no-seq| replace:: ``(seq, node, edge, cost, agg_cost)``
 .. |result-m-1-no-seq| replace:: ``(seq, start_vid, node, edge, cost, agg_cost)``
 .. |result-node-color| replace:: ``(vertex_id, color_id)``
+.. |result_node_color| replace:: ``(node, color)``
 .. |result_edge_color| replace:: ``(edge, color)``
 .. |result-node| replace:: ``(node)``
 .. |result-edge| replace:: ``(edge)``

doc/src/migration.rst

@@ -34,6 +34,7 @@ Migration to standardized columns
 .. |pid-m-m| replace:: ``(seq, path_seq, start_pid, end_pid, node, edge, cost, agg_cost)``
 .. |matrix-pid| replace:: ``(start_pid, end_pid, agg_cost)``
 .. |old-edge-color| replace:: ``(edge_id, color_id)``
+.. |old-node-color| replace:: ``(vertex_id, color_id)``
 
 There has been an effort to standardize function output columns names and
 types.
@@ -84,6 +85,8 @@ types.
      - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_binaryBreadthFirstSearch` [3]_
      - `Migration of single path functions`_
+   * - .. versionchanged:: 4.0.0 :doc:`pgr_bipartite` [3]_
+     - `Migration of output column name change`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_dagShortestPath` [3]_
      - `Migration of single path functions`_
    * - .. versionchanged:: 4.0.0 :doc:`pgr_edgeColoring` [3]_
@@ -854,6 +857,17 @@ Before update:
 * To get the old version column names: in the ``SELECT`` clause use ``edge AS
   edge_id`` and ``color AS color_id``
 
+.. rubric:: :doc:`pgr_bipartite`
+
+From: |old-node-color|
+To: |result-node-color|
+
+Before update:
+
+* Rename ``vertex_id`` to ``node`` and ``color_id`` to ``color``.
+* To get the old version column names: in the ``SELECT`` clause use ``node AS
+  vertex_id`` and ``color AS color_id``
+
 Migration of deleted functions
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 

pgtap/coloring/bipartite/types_check.pg

@@ -19,16 +19,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  ********************************************************************PGR-GNU*/
 BEGIN;
 
-SELECT CASE WHEN NOT min_version('3.2.0') THEN plan(1) ELSE plan(5) END;
+SELECT CASE WHEN min_version('4.0.0') THEN plan(5) ELSE plan(1) END;
 
 CREATE OR REPLACE FUNCTION types_check()
 RETURNS SETOF TEXT AS
 $BODY$
 BEGIN
 
-  IF NOT min_version('3.2.0') THEN
+  IF NOT min_version('4.0.0') THEN
     RETURN QUERY
-    SELECT skip(1, 'Function is new on 3.2.0');
+    SELECT skip(1, 'pgr_bipartite: testing only signatures standardaized in v4.0.0.');
     RETURN;
   END IF;
 
@@ -38,7 +38,7 @@ BEGIN
 
   RETURN QUERY
   SELECT function_args_eq('pgr_bipartite',
-    $$SELECT  '{"","vertex_id","color_id"}'::TEXT[] $$
+    $$SELECT  '{"","node","color"}'::TEXT[] $$
   );
 
   RETURN QUERY