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

[DOC] fix sym.arange doc #14237

Merged
merged 6 commits into from
Mar 12, 2019
Merged

[DOC] fix sym.arange doc #14237

merged 6 commits into from
Mar 12, 2019

Conversation

eric-haibin-lin
Copy link
Member

Description

Make sym.arange documentation consistent with that of nd.arange and np.arange. @icemelon9

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)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • 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:https://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@roywei
Copy link
Member

roywei commented Feb 23, 2019

@mxnet-label-bot add [Doc]

@marcoabreu marcoabreu added the Doc label Feb 23, 2019
roywei
roywei approved these changes Feb 23, 2019
View reviewed changes
Copy link
Member

@roywei roywei left a comment

Choose a reason for hiding this comment

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

Thanks for the fix. LGTM!

python/mxnet/symbol/symbol.py Outdated Show resolved Hide resolved
@eric-haibin-lin eric-haibin-lin mentioned this pull request Feb 23, 2019
Closed
wkcn
wkcn approved these changes Feb 24, 2019
View reviewed changes
Copy link
Member

@wkcn wkcn left a comment

Choose a reason for hiding this comment

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

Thank you for the fix.
LGTM : )

@vandanavk
Copy link
Contributor

@eric-haibin-lin could you re-trigger CI?

@mxnet-label-bot add [pr-awaiting-merge]

PR can be merged once CI passes.

@marcoabreu marcoabreu added the pr-awaiting-merge Review and CI is complete. Ready to Merge label Mar 4, 2019
wkcn
wkcn approved these changes Mar 12, 2019
View reviewed changes
python/mxnet/symbol/symbol.py
Parameters
----------
start : number
start : number, optional
Copy link
Member

Choose a reason for hiding this comment

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

Why modify it? It seems start doesn't have default value, but stop has one (None)

Edit:
It is coincident with NumPy.

@wkcn wkcn merged commit 89bebd1 into apache:master Mar 12, 2019
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
@eric-haibin-lin @vdantu
[DOC] fix sym.arange doc (apache#14237)
a6b1a12 
* fix doc

* Update symbol.py

* Retrigger CI
nswamy pushed a commit that referenced this pull request Apr 5, 2019
@eric-haibin-lin @nswamy
[DOC] fix sym.arange doc (#14237)
3e94618 
* fix doc

* Update symbol.py

* Retrigger CI
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
@eric-haibin-lin
[DOC] fix sym.arange doc (apache#14237)
0bca2a9 
* fix doc

* Update symbol.py

* Retrigger CI
@eric-haibin-lin eric-haibin-lin deleted the arange branch September 2, 2019 23:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@wkcn wkcn wkcn approved these changes

@roywei roywei roywei approved these changes

@szha szha Awaiting requested review from szha szha is a code owner

Assignees
No one assigned
Labels
Doc pr-awaiting-merge Review and CI is complete. Ready to Merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@eric-haibin-lin @roywei @vandanavk @wkcn @marcoabreu