Skip to content

Fix and enhance wrong doc-strings of all batch_transform and output_transform#2384

Merged
Nic-Ma merged 6 commits intoProject-MONAI:devfrom
Nic-Ma:fix-wrong-doc-string
Jun 17, 2021
Merged

Fix and enhance wrong doc-strings of all batch_transform and output_transform#2384
Nic-Ma merged 6 commits intoProject-MONAI:devfrom
Nic-Ma:fix-wrong-doc-string

Conversation

@Nic-Ma
Copy link
Copy Markdown
Contributor

@Nic-Ma Nic-Ma commented Jun 17, 2021

Description

According to Clara users' feedback and FAQs about handlers, this PR enhanced the doc-strings of all the batch_transform and output_transform args of handlers to explicitly indicate what this callable will get and from where and be used for what.
Also fixed some wrong doc-string and added missing doc-string.

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
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jun 17, 2021

/black

@Nic-Ma Nic-Ma force-pushed the fix-wrong-doc-string branch from d33a07e to b61463a Compare June 17, 2021 08:33
@Nic-Ma
Copy link
Copy Markdown
Contributor Author

Nic-Ma commented Jun 17, 2021

/black

@Nic-Ma Nic-Ma enabled auto-merge (squash) June 17, 2021 08:39
@Nic-Ma Nic-Ma merged commit 82fc4c1 into Project-MONAI:dev Jun 17, 2021
@Nic-Ma Nic-Ma deleted the fix-wrong-doc-string branch July 2, 2021 23:38
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.

2 participants