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

[Doc] broadcast axis is alias to broadcast axes #15546

Merged

Conversation

ChaiBapchya
Copy link
Contributor

@ChaiBapchya ChaiBapchya commented Jul 16, 2019

Description

Minor doc fix - doc doesn't mention that broadcast_axis and broadcast_axes are same (one is alias of the other)

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • Changes are complete (i.e. I finished coding on this PR)
  • Code is well-documented:
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • doc fix

@ChaiBapchya
Copy link
Contributor Author

@mxnet-label-bot add [Doc]

@marcoabreu marcoabreu added the Doc label Jul 16, 2019
@larroy
Copy link
Contributor

larroy commented Jul 16, 2019

Thanks for the PR @ChaiBapchya !

May I suggest to also fix the documentation? the comments are C++ style "//" instead of "#" which work in python. So you paste the example and doesn't work.
Also making the description of what this operator does would be helpful, to me the description doesn't say much to me.

@larroy
Copy link
Contributor

larroy commented Jul 16, 2019

@aaronmarkham

@aaronmarkham
Copy link
Contributor

@larroy There is a way to get both C++ and Python examples in the docs.
@ChaiBapchya You still have an open PR for that: #14243
Did you want to try to tie up these loose ends and use a common pattern for these updates?

@ChaiBapchya
Copy link
Contributor Author

Sure. Thanks for approving this PR. That PR seems to need another approval (apart from yours!) Will bump it up!

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit 4d07d78 into apache:master Jul 16, 2019
@ChaiBapchya ChaiBapchya deleted the broadcast_axis_alias_doc_fix branch July 17, 2019 20:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants