NatLabRockies / NatLabRockies/OpenStudio
Fix inconsistent API in ControllerOutdoorAir
Open
Nobody has claimed this yet.
component - Model
Enhancement Request
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Enhancement Request
Getters are called getXXX(), not xxx() and they return optional when they have a default.
Detailed Description
https://github.com/NREL/OpenStudio/pull/4948#discussion_r1323035396
Possible Implementation
Deprecate existing getters, add new non optional returning ones
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 with the ControllerOutdoorAir API and read the discussion in PR 4948, especially the linked review comment. Compare its existing getter names and return behavior with the stated conventions; done means the old getters are deprecated and corresponding non-optional getters follow the requested naming and default-value behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100