Skip to content

[JS] Create Documentation #125

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

Open
asfimport opened this issue Jun 8, 2018 · 2 comments
Open

[JS] Create Documentation #125

asfimport opened this issue Jun 8, 2018 · 2 comments
Labels
Type: enhancement New feature or request

Comments

@asfimport
Copy link

https://github.com/apache/arrow/tree/master/js currently only has a handful of examples but no API documentation.

Reporter: Dominik Moritz / @domoritz

Note: This issue was originally created as ARROW-2688. Please see the migration documentation for further details.

@asfimport
Copy link
Author

Wes McKinney / @wesm:
There is published auto-generated API documentation: http://arrow.apache.org/docs/js/. It would be useful to start a user-facing prose documentation project (like the non-API parts of http://arrow.apache.org/docs/python/), is that what you mean?

It would be good to point users to the API documentation in the JS readme. I opened ARROW-2697 about this

@asfimport
Copy link
Author

Dominik Moritz / @domoritz:
I think arrow js needs both user-facing prose documentation and API docs with comments for each component.

@assignUser assignUser added the Type: enhancement New feature or request label May 26, 2025
@assignUser assignUser transferred this issue from apache/arrow May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants