[GitHub] aaronmarkham commented on issue #12939: initializer.InitDesc docs error

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

aaronmarkham commented on issue #12939: initializer.InitDesc docs error
URL: https://github.com/apache/incubator-mxnet/issues/12939#issuecomment-436808062
 
 
   Notes on `ERROR: Undefined substitution referenced`:
   
   ## Undefined substitution reference error
   
   ```
   ERROR: Undefined substitution referenced: "x".
   ```
   
   In some math examples, people will use `|var|` to express the absolute value of something. The usage of pipes around a name is special to Sphinx and triggers a substitution of that value for something that is defined in the doc later. Switching to actual code or escaping the math can fix this.
   
   ```
               absolute value str((-|--x--|-/size(x)).asscalar()).
               absolute value str((*abs(x**)*/size(x)).asscalar()).
   ```
   
   An inline literal would work too:
   ```
               absolute value str((-|--x--|-/size(x)).asscalar())-.-
               ``absolute value str((|*x|*/size(x)).asscalar())``
   ```
   Or a regular block would work:
   ```
   """
   Some description ::
   
       absolute value str((|*x|*/size(x)).asscalar())
   
   Where you made sure there were line breaks before and after the indented code block 
   ```
   
   Or a `code-block` should work:
   ```
       .. code-block:: python
   
          absolute value str((|*x|*/size(x)).asscalar())
   
   ```
   

----------------------------------------------------------------
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