apache / apache/arrow

[C++][Docs] Guidelines for writing documentation comments

Open
#47,471 5 comments 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Status: stale-warning Type: usage
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

As discussed [here](https://github.com/apache/arrow/pull/47204?utm_source=chatgpt.com#discussion_r2315337345), there doesn’t seem to be a specific guideline for documentation comments. Does Arrow C++ follow any established conventions across the project? Or is there an existing guideline that can be applied consistently throughout the project?

### Component(s)

C++, Documentation

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.