NatLabRockies / NatLabRockies/EnergyPlus
Remove Feature Request or Update IO Reference
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.6k
- Forks
- 490
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 22
Description
Issue overview
The Wall:Detailed, RoofCeiling:Detailed, Floor:Detailed, and many other objects don't seem necessary considering the versatility of the BuildingSurface:Detailed object. The only example file with those objects present is "_SmallOffice_Dulles.idf".
If these objects serve a great purpose, the documentation needs to be updated in the IO Reference. One very obvious typo in RoofCeiling:Detailed is
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the listed Wall:Detailed, RoofCeiling:Detailed, and Floor:Detailed objects with BuildingSurface:Detailed in the IO Reference and the _SmallOffice_Dulles.idf example. Determine whether the objects should be retained or removed, then document the decision and correct the RoofCeiling:Detailed typo. The issue is resolved when the reference and example are consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100