Skip to content

Enhance the doc-string of CacheDataset#2279

Merged
wyli merged 6 commits intoProject-MONAI:devfrom
Nic-Ma:enhance-cachedataset-doc
May 29, 2021
Merged

Enhance the doc-string of CacheDataset#2279
wyli merged 6 commits intoProject-MONAI:devfrom
Nic-Ma:enhance-cachedataset-doc

Conversation

@Nic-Ma
Copy link
Copy Markdown
Contributor

@Nic-Ma Nic-Ma commented May 28, 2021

Description

According to our discussion, this PR enhanced the doc-string of CacheDataset to make it clear how to debug or verify.

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

@Nic-Ma Nic-Ma requested review from ericspod, rijobro and wyli May 28, 2021 17:08
@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented May 28, 2021

/black

@wyli wyli enabled auto-merge (squash) May 29, 2021 00:53
@wyli wyli merged commit 70f9fd1 into Project-MONAI:dev May 29, 2021
@Nic-Ma Nic-Ma deleted the enhance-cachedataset-doc branch July 2, 2021 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants