Opened 11 years ago

Last modified 11 years ago

#6538 new Tasks

property map documentation is overlay complicated

Reported by: anonymous Owned by: Douglas Gregor
Milestone: To Be Determined Component: property_map
Version: Boost 1.48.0 Severity: Cosmetic
Keywords: documentation Cc:

Description

The documentation of property map is overly complicated, for a few reasons:

  1. References to the Graph library. Considering that many readers of the documentation will be referred from the Graph library, they are being send in circles. Those not referred from the Graph library won't be helped either.
  1. Too many indications of what property_map is similar to. These are generally not helpful: better to say what it is, than what it looks like.
  1. Complicated examples.

I am attaching a rewrite of property_map.html

Attachments (4)

property_map.html (10.2 KB ) - added by anonymous 11 years ago.
rewrite of property_map.html
property_map.2.html (10.5 KB ) - added by anonymous 11 years ago.
revised, version 2
property_map.3.html (15.1 KB ) - added by Alex Hagen-Zanker <ahh34@…> 11 years ago.
a more rigorous rewrite
property_concepts.zip (10.9 KB ) - added by anonymous 11 years ago.
Further update to property_map.html as well as individual concept pages

Download all attachments as: .zip

Change History (6)

by anonymous, 11 years ago

Attachment: property_map.html added

rewrite of property_map.html

comment:1 by Jeremiah Willcock, 11 years ago

I like the direction that this is going, and like your version of the file more than the existing one. Please add your name and an updated copyright message to the new file. It needs a few small edits, which I'll do after you submit an updated version of the file.

by anonymous, 11 years ago

Attachment: property_map.2.html added

revised, version 2

comment:2 by anonymous, 11 years ago

Thank you for looking into this, and making some additional edits. I submitted a version 2 of the property_map.html, that contains some corrections + copyright information.

by Alex Hagen-Zanker <ahh34@…>, 11 years ago

Attachment: property_map.3.html added

a more rigorous rewrite

by anonymous, 11 years ago

Attachment: property_concepts.zip added

Further update to property_map.html as well as individual concept pages

Note: See TracTickets for help on using tickets.