Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Correct the function name in the .md file. For example, in case of the above warning, there is not operator called broadcast_logical_not. Changed it to logical_not to fix the warning.

Incorrect cross-linking Warning

/home/ubuntu/incubator-mxnet/python/mxnet/rnn/rnn.py:docstring of mxnet.rnn.save_rnn_checkpoint:None: WARNING: more than one target found for cross-reference u'RNNCell': mxnet.rnn.RNNCell, mxnet.gluon.rnn.RNNCell

Specify the correct class's reference. For example, for the above error, the fix was to specify mxnet.rnn.RNNCell


Tip for unknown or ambiguous references

Sphinx gets confused when there are more than one function or variable with the same name. Things like name, type, shape, or reshape, save, or load are generic and appear often in different modules. References to these should be specific.

When referencing a local class, prefix it with a dot as seen in the following example:

...