Re: [Boost-bugs] [Boost C++ Libraries] #3807: Documentation improvement for graph/planar_canonical_ordering.hpp.

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #3807: Documentation improvement for graph/planar_canonical_ordering.hpp.
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-05-19 12:39:49

#3807: Documentation improvement for graph/planar_canonical_ordering.hpp.
--------------------------------------------------+-------------------------
  Reporter:  Tim Gee <writetotimgee@…>            |       Owner:  asutton                  
      Type:  Bugs                                 |      Status:  reopened                 
 Milestone:  Boost 1.42.0                         |   Component:  graph                    
   Version:  Boost 1.41.0                         |    Severity:  Cosmetic                 
Resolution:                                       |    Keywords:  planar canonical ordering
--------------------------------------------------+-------------------------
Changes (by patcher@…):

  * status:  closed => reopened
  * resolution:  fixed =>

Comment:

 The change of documentation is to confusing. The condition c) is not
 necessary!

 In fact, the
 [http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/PlanarEmbedding.html

 documentation] says, that the embedding used for planar_canonical_ordering
 is a [http://en.wikipedia.org/wiki/Graph_embedding#Combinatorial_embedding

 combinatorical  embedding], not a geometrical (topological) embedding.
 Hence, there aren't any faces yet.

 In starting with the first two vertices, the algorithm defines these both
 vertices to be on the outer face of an geometrical embedding, which one
 gets implicitly by the canonical order, see the
 [http://www.boost.org/doc/libs/1_43_0/libs/graph/doc/planar_canonical_ordering.html

 documentation].

 So the condition c) is always met and hence not needed to be mentioned.
 So delete this condition?

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/3807#comment:6>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.