Display unit for input param only if it is type Real or std::vector<Real> #29116
Conversation
|
Job Documentation, step Docs: sync website on a5484ff wanted to post the following: View the site here This comment will be updated on new commits. |
|
Do we not have unit tests for this? |
|
Job Coverage, step Generate coverage on a5484ff wanted to post the following: Framework coverage
Modules coverageCoverage did not change Full coverage reportsReports
This comment will be updated on new commits. |
||||||||||||||||||||||||||
There are some unit tests for checking the appSyntax extension and addition of the unit parameter. With this change I'm currently missing something as the tests return an exception in debug that I'm looking into. Currently, the docs show 'unit: (no unit assumed) for every single input parameter regardless of its type. |
|
I found the issue. The test currently creates a Diffusion Kernel object and only tests on the 'variable' input parameter, which now no longer has a unit specified so it asserts. I'll update/add a new test. |
| html.String(p, content='(no unit assumed)') | ||
| else: | ||
| html.String(p, content=doc_unit) | ||
| if cpp_type == "double" or cpp_type == "std::vector<double>": |
There was a problem hiding this comment.
let's also keep vectors of vectors and vectors of vectors and vectors.
and any map that ends with Real as the item or the key (terrible idea for the key)
There was a problem hiding this comment.
axctually, let's move this if condition to the "if not doc_unit" clause,
and always obey the user specification of a unit
Sounds good. Let me know if you need another hand |
Refs #27352 and #29115.