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

Clean up some Sphinx warnings. #13539

Merged
merged 1 commit into from
Dec 5, 2018
Merged

Conversation

vishaalkapoor
Copy link
Contributor

Description

  • Correct some markup that is causing Sphinx warnings.
  • Remove illegal line-break and elipsis
  • Remove isinf, isfinite, isnan as they are not in the symbol.contrib package.
  • Add whitespace after docstring in .cc file.

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
    NCCL)
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@vishaalkapoor
Copy link
Contributor Author

@aaronmarkham Please take a look. I removed the Scala files that were causing warnings (we talked about offline) as you've edited those.

Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had one suggestion about the link, but it is totally minor... if this passes CI, I'd like to get the fixes in ASAP, and worry about relative links another time.
Let's also hear back from @eric-haibin-lin and @zheng-da about the symbol/contrib page, but they're good with it, then this is GTG.

@@ -55,9 +55,6 @@ In the rest of this document, we list routines provided by the `symbol.contrib`
foreach
while_loop
cond
isinf
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just encountered this as well. I think it is ok to remove...
I made a likewise comment and am awaiting confirmation.

- [Contributor Guidelines](http://mxnet.io/community/contribute.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're updating links, please switch them to relative.

Copy link
Contributor Author

@vishaalkapoor vishaalkapoor Dec 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This just removes an invisible character that's causing a sphinx warning about a hard line break that was illegal.
But I'll update the two links to be relative as well

@@ -82,7 +82,6 @@ def forward(self, F, inputs, tree):
for child in tree.children]
#Recursively builds the neural network based on each input sentence’s
#syntactic structure during the model definition and training process
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this breaking something or is your editor linting things?

Copy link
Contributor Author

@vishaalkapoor vishaalkapoor Dec 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing an warning about this block, and when this char was removed, I was able to remove that warning (illegal UTF-8)

@@ -795,7 +795,8 @@ uniform probability.

out[2]
[0 0 0 0 0]
<NDArray 5 @cpu(0)>
<NDArray 5 @cpu(0)>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this to be a problem as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@aaronmarkham
Copy link
Contributor

Ok, we're good to remove those entries on the symbol page.

@vishaalkapoor
Copy link
Contributor Author

vishaalkapoor commented Dec 4, 2018

@aaronmarkham Updated as per comments including the relative links. thanks!

@aaronmarkham aaronmarkham merged commit d2102fa into apache:master Dec 5, 2018
@vishaalkapoor vishaalkapoor changed the title [MXAPPS-1020] Clean up some Sphinx warnings. Clean up some Sphinx warnings. Dec 5, 2018
zhaoyao73 pushed a commit to zhaoyao73/incubator-mxnet that referenced this pull request Dec 13, 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