Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[MXNET-248] Scala Infer API docs editorial pass #10307

Merged
merged 6 commits into from
Apr 5, 2018

Conversation

aaronmarkham
Copy link
Contributor

Preview

http://107.21.90.138/api/scala/docs/index.html#ml.dmlc.mxnet.infer.package

Edited every scala file in the Infer package that had any comments, and added comments to the SSD example.

Comments

There are quite a variety of scaladoc errors and warnings that need to be resolved, however, the output seems fine.

27 warnings found
131 errors found

Scala API contributors: please run make docs and check the output on the files you contributed or are maintaining, and resolve the issues!

@aaronmarkham aaronmarkham changed the title Scala Infer API docs editorial pass [MXNET-248] Scala Infer API docs editorial pass Mar 28, 2018
@nswamy
Copy link
Member

nswamy commented Apr 3, 2018

@aaronmarkham please rebase your branch from the master, this PR has a lot of edits to files that you probably didn't touch

@aaronmarkham
Copy link
Contributor Author

I think it expanded due to my rebase yesterday. The CI failure is scalastyle it seems...
I can fix the style by adjusting the comments... I'm fairly sure at least.
However, I feel like this is something that should have been caught earlier. Docs built just fine locally... would have been nice to know before jamming things up in a PR.

@nswamy nswamy merged commit 78b971a into apache:master Apr 5, 2018
@aaronmarkham aaronmarkham deleted the scaladocs branch April 12, 2018 22:14
rahul003 pushed a commit to rahul003/mxnet that referenced this pull request Jun 4, 2018
zheng-da pushed a commit to zheng-da/incubator-mxnet that referenced this pull request Jun 28, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants