daveliepmann opened a new pull request #12974: Improve clojure tutorial
URL: https://github.com/apache/incubator-mxnet/pull/12974
 
 
   ## Description ##
   This is a documentation PR.
   
   I updated the Clojure REPL-based tutorials (e.g. 
*contrib/clojure-package/examples/tutorial/src/tutorial/module.clj*) to match 
their online/markdown versions (e.g. [Module 
API](https://mxnet.incubator.apache.org/api/clojure/module.html)). This will 
allow people to more easily switch back and forth from the online and REPL 
versions of the same tutorial.
   
   This primarily involved standardizing section headings to four-semicoloned 
comments with an extra line of whitespace above them, wrapping long lines, and 
adding namespace docstrings. In the Symbol tutorial I removed a duplicated 
section and some sections that seem to be partially copied from the [basic 
tutorial](https://mxnet.incubator.apache.org/tutorials/basic/symbol.html), but 
which did not seem to make sense out of that context. (I would like to circle 
back in a later PR to completely translate that tutorial to Clojure.)
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   - [x] Changes are complete (i.e. I finished coding on this PR)
   - [x] To the my best knowledge, examples are either not affected by this 
change, or have been fixed to be compatible with this change
   
   ### Changes ###
   - [x] Clojure Module API tutorial
   - [x] Clojure KVStore API tutorial
   - [x] Clojure NDArray API tutorial
   - [x] Clojure Symbol API tutorial
   
   ## Comments ##
   I fixed three small .clj-tutorial-adjacent issues in the course of this PR:
    - deleted a duplicated section in the online/markdown docs 
(https://github.com/apache/incubator-mxnet/commit/b846d634d5b3908ef32ad5e52c208d9dcf145b37)
    - fixed a code-block typo in the online docs 
(https://github.com/apache/incubator-mxnet/commit/8597817d727fcfe83af89255b0cde21e2f8ac390)
    - I changed the Maven dependency that the tutorials run on from the 
(unreleased and therefore unusable-without-extra-steps) version 1.3.1-SNAPSHOT 
of coordinates which don't seem to exist to 1.3.0 of coordinates that are 
referenced in [the new 
README](https://github.com/apache/incubator-mxnet/pull/12881) 
(https://github.com/apache/incubator-mxnet/commit/bf8391e78a5bb0513bd8cfc307d5f8fb31f524b4)

----------------------------------------------------------------
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:
[email protected]


With regards,
Apache Git Services

Reply via email to