Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Should use "Real" #13351

Open
friedmud opened this issue May 2, 2019 · 3 comments
Open

Documentation Should use "Real" #13351

friedmud opened this issue May 2, 2019 · 3 comments
Labels
C: Documentation Good first issue P: minor A defect that does not affect the accuracy of results. T: task An enhancement to the software.

Comments

@friedmud
Copy link
Contributor

friedmud commented May 2, 2019

Reason

Documentation for objects should use "Real" instead of "double".

For example, look at the "default" parameter here: https://mooseframework.org/source/postprocessors/Receiver.html

Design

See above

Impact

More accurate: the documentation should reflect what people need to type in code.

@friedmud friedmud added P: minor A defect that does not affect the accuracy of results. T: task An enhancement to the software. P: normal A defect affecting operation with a low possibility of significantly affects. C: Documentation Good first issue labels May 2, 2019
@friedmud friedmud added this to Project Ideas in Intern Project Ideas via automation May 2, 2019
@permcody permcody removed the P: normal A defect affecting operation with a low possibility of significantly affects. label May 14, 2019
@jmeziere
Copy link
Contributor

jmeziere commented Jan 2, 2020

@friedmud These changes would need to be made in the .md files, correct? Also, these are all over the place, correct? We'd need to use a finder, and go through all the instances of double that show up and decide if it is supposed to be there or not?

@JackHanni
Copy link

@permcody @friedmud These changes would need to be made in the .md files, correct? Also, these are all over the place, correct? We'd need to use a finder, and go through all the instances of double that show up and decide if it is supposed to be there or not?

@permcody
Copy link
Member

Hi Jack, Actually no, the tables you see on the documentation page aren't built from explicit markup in the .md files. They are generated automatically from the dump of syntax from the inputParameters functions that are spread throughout MOOSE. The issue is that Real is just a typedef for double so we are losing the "alias" somewhere along the way. This should actually be a really small change but will require a fair amount of sleuthing. I don't know if the Real type is getting lost in the dump (on the C++ side) or in the table generation on the Python side. Tagging @aeslaughter to see if he knows.

What this ticket is not is changing a bunch of files all over the place, it's hopefully just one or two small changes. It's still important though. Thanks for your interest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Documentation Good first issue P: minor A defect that does not affect the accuracy of results. T: task An enhancement to the software.
Projects
Intern Project Ideas
  
Project Ideas
Development

No branches or pull requests

4 participants