[Docs] Add licensing header to C data interface in docs

Open Beginner friendly
#50,119 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
c
Domain
documentation

Research direction

Start at the C Data Interface documentation page and its Structure Definitions section, then locate the source for the embedded C header. Review how the Arrow project presents license and NOTICE information before updating the header and surrounding explanation. Done means the provided header has an appropriate direct license header and the documentation no longer leaves redistribution guidance ambiguous.

Written by the indexing model from the issue text.

Description

Component: Documentation Type: enhancement
Describe the enhancement requested

At https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions, a header file for the C data interface is provided. It does not carry any direct license headers, but states:

Like the rest of the Arrow project, they are available under the Apache License 2.0.

This can cause confusion for further redistribution and/or requires each user to correctly apply the corresponding header, while a recommended declaration could be provided by the Arrow project directly.

Depending on how you read/interpret the Apache-2.0 license in this regard, adding a license header myself could require me to add an explicit notice about me having added the license header (section 4b) and possibly even including the NOTICE.txt file of the Arrow project (section 4d).

Component(s)

Documentation

Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
93

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.

More from apache/arrow

All issues in apache/arrow

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.