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

[Clojure] Better api docstrings by replacing newlines #14752

Merged
merged 1 commit into from
Apr 23, 2019

Conversation

kedarbellare
Copy link
Contributor

Description

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

  • API docstrings and associated generator tests

Comments

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

@kedarbellare
Copy link
Contributor Author

cc @Chouffe (thanks for the idea!)

@gigasquid
Copy link
Member

So nice!!! Thanks @kedarbellare and @Chouffe !

@Chouffe
Copy link
Contributor

Chouffe commented Apr 21, 2019

LGTM! Not sure why the windows-cpu CI job is failing though. 💯 @kedarbellare!

@gigasquid
Copy link
Member

I'll kick the CI again

Copy link
Member

@gigasquid gigasquid left a comment

Choose a reason for hiding this comment

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

This is a great addition! Good to go as soon as CI passes 😸

@gigasquid gigasquid merged commit a1b0a3a into apache:master Apr 23, 2019
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
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.

3 participants