Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[C++][Docs] C++ documentation for constructors is missing #45863

Open
maciekgajewski opened this issue Mar 19, 2025 · 3 comments
Open

[C++][Docs] C++ documentation for constructors is missing #45863

maciekgajewski opened this issue Mar 19, 2025 · 3 comments

Comments

@maciekgajewski
Copy link

Describe the bug, including details regarding any error messages, version, and platform.

The C++ doco contains generated documentation for methods, but not for constructors. This makes it incomplete.

Component(s)

Documentation

@kou kou changed the title [C++][Doc] C++ documentation for constructors is missing [C++][Docs] C++ documentation for constructors is missing Mar 19, 2025
@amoeba
Copy link
Member

amoeba commented Mar 20, 2025

Hi @maciekgajewski, thanks for the report.

Do you have an example of a constructor that isn't documented that you think should be? I haven't done a comprehensive search but some classes in Arrow C++ have their constructors hidden behind public interfaces (e.g., RecordBatchReader) while other classes do expose their constructor (e.g., LocalFileSystem).

@maciekgajewski
Copy link
Author

None of the public constructors seem to be documented, and not everything can be achieved with the factory functions.

Examples:

  • Array - how to create an Array from data buffer?
  • TimestampType- how to create TimestampType instance with specific time unit?

@amoeba
Copy link
Member

amoeba commented Mar 20, 2025

Right. I think a PR would be welcome then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants