NatLabRockies / NatLabRockies/OpenStudio
... online OpenStudio SDK documentation for "functions"?
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Pretty much a word-for-word re-transcription of a recent UMH post:
Up until v3.6.1, one could consult OpenStudio SDK online documentation on functions (e.g. joinAll, polygonInPolygon) under the OpenStudio:Utilities Namespace Reference document:
These (very useful) functions are still available (and working) with OpenStudio version 3.7.0 and up. Yet I'm now hitting a dead end for v3.7.0+ online SDK documentation:
I may be missing something really obvious. Any hints where similar content (possibly updated) may be found for versions 3.7.0+? Thanks in advance.
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
Compare the OpenStudio 3.6.1 and 3.9.0 Utilities Namespace Reference links in the issue, focusing on whether functions such as joinAll and polygonInPolygon are present in the generated documentation. Determine where the v3.7.0+ SDK documentation is generated or published; done means the functions are accessible in the online documentation or their current documented location is clearly identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100