You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/01/30 19:09:07 UTC
[GitHub] [arrow] TheNeuralBit opened a new pull request #9375: [ARROW-951] Upgrade to typedoc 0.20.19
TheNeuralBit opened a new pull request #9375:
URL: https://github.com/apache/arrow/pull/9375
Also ran `npm audit fix`
This PR upgrades us beyond [typedoc 0.20](https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0) which made significant improvements to how re-exported objects are handled. I've uploaded a preview of the generated docs at https://theneuralbit.github.io/arrow-typedoc-0.20/. Compare this to the existing API docs at http://arrow.apache.org/docs/js/index.html,
It properly reflects our two top-level modules, Arrow.dom and Arrow.node, and shows the objects exported within them.
There's still a lot of work to do to make these API docs useful, but I think this is a big step in the right direction. Some remaining issues that we could file follow-up jiras for:
- Some objects are missing (e.g. Vector sub-classes like DateVector, FloatVector, ..). These also seem to be missing from the existing docs. It's possible this is a bug in typedoc? Will need further investigation.
- Many classes and methods are still completely undocumented, so API docs tell users little aside from the structure of the code.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #9375: [ARROW-951] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-770265713
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for opening a pull request!
Could you open an issue for this pull request on JIRA?
https://issues.apache.org/jira/browse/ARROW
Then could you also rename pull request title in the following format?
ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - How to contribute patches](https://arrow.apache.org/docs/developers/contributing.html#how-to-contribute-patches)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] nealrichardson commented on pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
nealrichardson commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-772137224
Merging; please feel free to make followup JIRAs. Plenty of time to polish the docs before the next release.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] nealrichardson closed pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
nealrichardson closed pull request #9375:
URL: https://github.com/apache/arrow/pull/9375
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] trxcllnt commented on pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
trxcllnt commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-770819384
@TheNeuralBit I think we have `/** @ignore */` on the vector subclasses, so they're excluded from the list of documented types.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] TheNeuralBit commented on pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
TheNeuralBit commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-770267672
One issue with this change - it will break existing links. For example the docs for `Table` moved from classes/table.html to classes/arrow_dom.table.html.
We could fix this by only generating using one entryPoint - either Arrow.dom.ts or Arrow.node.ts (or Arrow.ts), not both.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-770265832
https://issues.apache.org/jira/browse/ARROW-951
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] domoritz commented on pull request #9375: ARROW-951: [JS] Upgrade to typedoc 0.20.19
Posted by GitBox <gi...@apache.org>.
domoritz commented on pull request #9375:
URL: https://github.com/apache/arrow/pull/9375#issuecomment-770821999
The new docs look great. The initial organization is a bit odd, though. There is a `Module` in the menu on the side with the two actual modules that are already listed below.
<img width="1281" alt="Screen Shot 2021-02-01 at 13 30 00" src="https://user-images.githubusercontent.com/589034/106459061-97845600-6491-11eb-92e0-42c51475610b.png">
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org