Opened 7 years ago

Closed 5 years ago

#4386 closed Bugs (fixed)

Some documentation bugs

Reported by: Matthias Berndt <matthias_berndt@…> Owned by: Andrew Sutton
Milestone: To Be Determined Component: graph
Version: Boost 1.43.0 Severity: Problem
Keywords: Cc:



i have hit a few documentation bugs in the graph library's documentation that made it hard for me to make sense of it.

On it says that VertexListGraph? refines IncidenceGraph? and AdjacencyGraph?, but this can't be seen in the diagram in figure 1.

On it says that VertexListGraph? refines Graph, but it doesn't say that it refines AdjacencyGraph? and IncidenceGraph?.

On it says: "Please note that astar_search_no_init() must be used for implicit graphs; the basic astar_search() function requires a graph that models VertexListGraph?". This seems to imply that astar_search_no_init() doesn't require a VertexListGraph?. Nevertheless, the template parameter in the prototype for the function is called VertexListGraph?. Shouldn't that be IncidenceGraph??

Attachments (0)

Change History (5)

comment:1 Changed 7 years ago by Jeremiah Willcock

Resolution: fixed
Status: newclosed

(In [63466]) Fixed various BGL documentation bugs; fixes #4386

comment:2 Changed 7 years ago by Matthias Berndt <matthias_berndt@…>

Resolution: fixed
Status: closedreopened

Hi again,

I am now confused.

And yet, you altered the documentation to say that VertexListGraph? doesn't refine IncidenceGraph? (which is confirmed by the fact that the VertexListGraphConcept? concept checking class doesn't check for out_edge_iterator etc). How does that fit together?

comment:3 Changed 7 years ago by Jeremiah Willcock

Resolution: fixed
Status: reopenedclosed

(In [63530]) Changed to using const reference for input graphs; added Incidence Graph requirements to documentation; fixes #4386

comment:4 Changed 5 years ago by Dave Abrahams

Resolution: fixed
Status: closedreopened

The confusion about astar_search_no_init's requirements and its template parameter names remains. The text is not very clear on what its requirements should be (presumably IncidenceGraph, but that's only a guess) and its template parameter name still implies VertexListGraph is required.

comment:5 Changed 5 years ago by Jeremiah Willcock

Resolution: fixed
Status: reopenedclosed

(In [81602]) Fixed template parameter names; fixes #4386

Modify Ticket

Change Properties
Set your email in Preferences
as closed The owner will remain Andrew Sutton.
The resolution will be deleted.

Add Comment

E-mail address and name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.