GEOS-DEV / GEOS-DEV/GEOS

LvArray container usage

Open
#2,070 1 comment 0 reactions 1 assignee View on GitHub

@CusiniM is already working on this.

Since Feb 17, 2023.

type: documentation
Dominant language
C++
Stars
287
Forks
109
Avg merge
4d 41m
Merged PRs (30d)
5

Description

What needs to be documented?
Which LvArray containers should be used for which intent?

What sort of documentation would help?
A general description of each type of array, with code examples illustrating their use.

What are the deficiencies of the existing documentation?
The LvArray documentation is technical and descriptive, but does not help deciding which container to use for each purpose.

Additional notes or context
Will be addressed during a Doc Day. Based on feedback from @jiemeng-total

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.