You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The new feature for setDocUnit to render in the input parameter descriptions added here: #27352 adds the unit for all types of input parameters, regardless if they should have units (e.g., bool, MooseEnum, int, etc.). By default for parameters where setDocUnit is not provided in the InputParameters list the following string is presented: '(no unit assumed)'. Discussions with others have suggested we suppress the presentation of the unit for params that are not Real or std::vector<Real> at this time.
Design
We have access to the cpp_type to also Render for the input parameters so we can query the type and check if it is Real or std::vector<Real> (on MooseDocs this is double or std::vector<double>) and do the current setting of the unit only if the cpp_type is either of these 2.
Another feature would be on the InputParameter side to error if the an input param of not these two types is passed to setDocUnit that and error is provided to the user.
Impact
Cleaner documentation.
The text was updated successfully, but these errors were encountered:
Motivation
The new feature for setDocUnit to render in the input parameter descriptions added here: #27352 adds the unit for all types of input parameters, regardless if they should have units (e.g., bool, MooseEnum, int, etc.). By default for parameters where
setDocUnit
is not provided in the InputParameters list the following string is presented: '(no unit assumed)'. Discussions with others have suggested we suppress the presentation of the unit for params that are notReal
orstd::vector<Real>
at this time.Design
We have access to the
cpp_type
to also Render for the input parameters so we can query the type and check if it isReal
orstd::vector<Real>
(on MooseDocs this isdouble
orstd::vector<double>
) and do the current setting of the unit only if thecpp_type
is either of these 2.Another feature would be on the InputParameter side to error if the an input param of not these two types is passed to
setDocUnit
that and error is provided to the user.Impact
Cleaner documentation.
The text was updated successfully, but these errors were encountered: