points_input Developers doc
Maintainers usually reply within 3 days
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
The issue points to two C source files: src/common/points_input.c and include/c_common/points_input.h. Start by reading these files to understand their functions and data structures. Use Doxygen syntax to write comments directly in the source code, focusing on function descriptions, parameters, and return values. Check the project's existing Doxygen documentation for examples of style and format. Once documented, verify by generating the documentation locally to ensure it renders correctly.
Written by the indexing model from the issue text.
Description
Write the developers documentation of the following files
https://github.com/pgRouting/pgrouting/blob/develop/src/common/points_input.c
https://github.com/pgRouting/pgrouting/blob/develop/include/c_common/points_input.h
We use Doxygen to generate the documentation
http://www.stack.nl/~dimitri/doxygen/
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 397
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 8
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pgRouting/pgrouting
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 3 days
-
Administrative Enhancement
Difficulty 1/5 Under an hour Newbie friendliness 80/100
Maintainers usually reply within 3 days
-
get_check_data developers docPossibly taken @withaman69 claimed this 102 days ago. OpenC/C++ Developers Doc. good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
pgRouting/pgrouting#972 · 7 comments ·
Maintainers usually reply within 3 days
-
pickdeliver: Create and use process/driver pairPossibly taken @cvvergara claimed this 6 days ago. OpenEnhancement Pick & Delivery
Difficulty 4/5 3-5 days Newbie friendliness 20/100
Maintainers usually reply within 3 days
All issues in pgRouting/pgrouting
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
KLayout/klayout#2554 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
LaneDibello/Kotor-Patch-Manager#375 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day