4862 Enhance docstring for the regular 2D image dims

[Nic-Ma]

Fixes #4862 .

Description

This PR enhanced the doc-string of LoadImage according to the suggestion from @ericspod , for the regular 2D image dims.

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 --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[Nic-Ma]

/black

[Nic-Ma]

/build

[ericspod]

Looks good though we should say that readers in general may reorder dimensions to match CHWD Pytorch ordering. PILReader does this but others do something similar like here.

[ericspod]

Minor changes but it's a good reminder to people, thanks!

[Nic-Ma]

Hi @ericspod ,

Thanks for your review.
I updated according to your comments, I didn't put "readers in general may reorder dimensions to match CHWD Pytorch ordering. PILReader does this but others do something similar like here.", because I feel "match CHWD PyTorch ordering" is slightly confusing..
Or do you have any other comments?

Thanks.

[Nic-Ma]

/black

[Nic-Ma]

/build

[wyli]

/build