Closed joseph-robertson closed 7 months ago
I realize you've already gone down a certain path and I'm coming to it late, but I can't help but wonder if it would be simpler to just include every argument in the options_lookup.tsv somewhere. Could even write a test to make sure they are all covered.
Suggestion from @afontani: We probably want to link to argument descriptions.
We need to better orient readers of the Housing Characteristics page to the idea of "auto" and what that means, how things connect to OS-HPXML documentation and HPXML fields, etc.
We should have a paragraph up front on "auto", and then for each ResStock parameter we should have link(s) to the related OS-HPXML documentation sections (e.g., HVAC Heating Efficiency
-> HPXML Heating Systems, HPXML Heat Pumps).
Edit: related to https://github.com/NREL/OpenStudio-HPXML/issues/1252.
Need to either (A) wait for source_report formatting updates, or (B) fix some of the list item indentation issues.
Pull Request Description
This PR:
<arg_name>=auto
) tooptions_lookup.tsv
so that every ResStockArguments argument is included.options_lookup.tsv
.options_lookup.tsv
(including Name, Required, Units, Type, Choices, Description). See below for example.README.md.erb
to all ResStock measures so thatREADME.md
documentation is automatically generated.Housing Characteristics
for describing subsections and the "auto" argument choice. See below.Checklist
Not all may apply:
openstudio tasks.rb update_measures
has been run