Skip to content

Commit

Permalink
[doc] modified docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prakashupes committed Aug 7, 2020
1 parent 5d2a06d commit 87c4d0e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 19 deletions.
9 changes: 5 additions & 4 deletions doc/coloring/pgr_bipartite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
This documentation is licensed under a Creative Commons Attribution-Share
Alike 3.0 License: http://creativecommons.org/licenses/by-sa/3.0/
****************************************************************************

pgr_bipartite -Experimental
===============================================================================

Expand All @@ -15,13 +15,13 @@ In particular, the is_bipartite() algorithm implemented by Boost.Graph.

.. figure:: images/boost-inside.jpeg
:target: https://www.boost.org/doc/libs/1_53_0/libs/graph/doc/is_bipartite.html

Boost Graph Inside

.. include:: experimental.rst
:start-after: begin-warn-expr
:end-before: end-warn-expr

.. rubric:: Availability


Expand Down Expand Up @@ -95,7 +95,8 @@ Additional Examples
The examples in this section use the following :ref:`fig1`


:Example: It also possibe the cyclic graph can also be bipartite:
:Example: It is possible that the cyclic graph can also be bipartite:

.. literalinclude:: doc-bipartite.queries
:start-after: --q2
:end-before: --q3
Expand Down
25 changes: 10 additions & 15 deletions doc/dominator/pgr_lengauerTarjanDominatorTree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,16 @@ Signatures
RETURNS SET OF (id,vid,idom)
:Example: **TBD**
.. index::
single: LTDTree
single: pgr_LengauerTarjanDominatorTree

Complete Signature
...............................................................................

.. code-block:: sql
:Example: The lengauer_tarjan_dominator_tree with root vertex :math:`2`
:Example: The lengauer_tarjan_dominator_tree with root vertex :math:`1`

.. literalinclude:: doc-lengauerTarjanDominatorTree.queries
:start-after: -- q1
:end-before: -- q2
:start-after: --q1
:end-before: --q2

Parameters
-------------------------------------------------------------------------------
Expand All @@ -65,7 +59,7 @@ Parameters
Column Type Description
============== ============ =================================================
**edges_sql** ``TEXT`` SQL query as described above.
**root_vid** ``BIGINT`` Identifier of the starting vertex.
**root_vid** ``BIGINT`` Identifier of the starting vertex.
============== ============ =================================================


Expand All @@ -91,14 +85,15 @@ Column Type Description

Additional Examples
------------------------------------------------------------------------------------------
The examples in this section use the following :ref:`fig1`

:Example: When the edge is disonnectd from graph then it will returns immidiate dominator of all vertex as zero except that edge:

:Example: To handle the one flag to choose signatures

The examples in this section use the following :ref:`fig1`

.. literalinclude:: doc-lengauerTarjanDominatorTree.queries
:start-after: -- q1
:end-before: -- q2
:start-after: --q2
:end-before: --q3

See Also
-------------------------------------------------------------------------------
Expand Down

0 comments on commit 87c4d0e

Please sign in to comment.