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

[clojure-package] improve docstrings in image.clj #14307

Merged
merged 1 commit into from
Mar 5, 2019
Merged

[clojure-package] improve docstrings in image.clj #14307

merged 1 commit into from
Mar 5, 2019

Conversation

Chouffe
Copy link
Contributor

@Chouffe Chouffe commented Mar 3, 2019

Description

  • Improved docstrings in image.clj
  • Added examples
  • Added types of parameters of functions

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

Comments

@Chouffe Chouffe requested a review from gigasquid as a code owner March 3, 2019 17:21
@anirudhacharya
Copy link
Member

@mxnet-label-bot add [pr-awaiting-review, Clojure]

@marcoabreu marcoabreu added Clojure pr-awaiting-review PR is waiting for code review labels Mar 4, 2019
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.

Love the docstrings 😍

@gigasquid gigasquid merged commit 21f67bd into apache:master Mar 5, 2019
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 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
Clojure pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants