Updates dostrings in controlsClass, RAT function, plotting and some utilities#342
Conversation
DrPaulSharp
left a comment
DrPaulSharp
left a comment
There was a problem hiding this comment.
Looks good, please have a look at the use of tab, which seem a bit off in a few places. I've also made some suggestions on how some of the descriptions can be improved, see what you think. I'll need to have a bit more thought about the Bayes results, see what you can come up with.
| % shiftedData [nContrasts x 1] cell Data shifted using given scale factor | ||
| % backgrounds [nContrasts x 1] cell background values for each contrast | ||
| % resolutions [nContrasts x 1] cell resolution values for each contrast | ||
| % layerSlds [nContrasts x nDomains] cell layers parameter values for each contrast |
There was a problem hiding this comment.
This is fine, but why is it called "layerSlds" when it also includes thickness and roughness???
There was a problem hiding this comment.
I don't know, I lifted the description from one of the docstrings
There was a problem hiding this comment.
Yeah, sorry. It was a more open/rhetorical question. Maybe one to look at on Monday.
alexhroom
left a comment
alexhroom
left a comment
There was a problem hiding this comment.
some extra small comments from looking at this in the Python!
StephenNneji
force-pushed
the
update_docstrings
branch
from
c9b48db to
869d093
Compare
DrPaulSharp
left a comment
DrPaulSharp
left a comment
There was a problem hiding this comment.
Looks good, just a couple of minor things to sort out.
3 participants
As part of #254
I added some info on the
resultstruct into the RAT function docstring probably can be improved. ModifiedsetProcedureso options are arguments not in a cell array. Also renamedproblemtoprojectin some places