dmlc / dmlc/xgboost

[jvm-packages] Scaladoc issues with 2.12

Open
#4,779 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
28.8k
Forks
8.9k
Avg merge
1d 12h
Merged PRs (30d)
54

Description

As we are moving to Scala 2.12 exclusivly, I can see we have moved to the new Scaladoc, however there seems to be something wrong, as the new layout is significantly harder to use.

XGBoost4j Docs: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j/index.html
XGBoost4j-spark Docs: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j-spark/index.html

Both of which are not very usefull because they hide all classes behind 5+ clicks, for example:
![image](https://user-images.githubusercontent.com/5735406/63138914-4c258000-c030-11e9-823a-7858fcb42d4f.png)

Perhaps we could link deeper into the classpath (from the xgboost.ai site), or change something else about how we are using Scaladoc with 2.12?

Deeper link example: https://xgboost.readthedocs.io/en/latest/jvm/scaladocs/xgboost4j-spark/ml/dmlc/xgboost4j/scala/spark/index.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.