[GitHub] zachgk opened a new pull request #13210: Fix descriptions in scaladocs for macro ndarray/sybmol APIs

[GitBox <gi...@apache.org>]

zachgk opened a new pull request #13210: Fix descriptions in scaladocs for macro ndarray/sybmol APIs
URL: https://github.com/apache/incubator-mxnet/pull/13210
 
 
   ## Description ##
   This fixes the Scala API docs page issues with the macro generated docs noted under https://github.com/apache/incubator-mxnet/issues/12657. 
   
   There were two major fixes:
   - Replace the \<pre\> tags used earlier with scaladoc code blocks
   - Add spaces to convert [[ to [ [. They are used for giving examples of NDArrays in python docs, but scaladocs treats [[ as a link which causes a warning since the link can't be resolved.
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   - [x] Code is well-documented: 
   - For user-facing API changes, API doc string has been updated. 
   - For new C++ functions in header files, their functionalities and arguments are documented. 
   - For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
   - Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
   - [x] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
   
   @lanking520 @andrewfayres @aaronmarkham @nswamy

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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


With regards,
Apache Git Services