Incomplete documentation for distributed property maps

Open
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp

Research direction

Start with doc/distributed_property_map.rst and compare its description with the complete usage example in test/distributed_property_map_test.cpp. Update the documentation to cover the GlobalMap parameter and verify that the explanation matches the actual distributed property map usage.

Written by the indexing model from the issue text.

Description

bug

The documentation for distributed property maps is missing any mention of the GlobalMap parameter of distributed property maps.

There is a complete example of how to use distributed property maps here.

To fix this issue, the documentation would need to be brought up to date with the actual use of distributed maps.

Dominant language
C++
Stars
33
Forks
41
Avg merge
1d 11h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/graph_parallel

All issues in boostorg/graph_parallel

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.