buildingSMART / buildingSMART/IFC4.x-development
Avoid circular definitions
- Dominant language
- Python
- Stars
- 234
- Forks
- 123
- Avg merge
- 15h 4m
- Merged PRs (30d)
- 5
Description
As pointed out by Soren Spile, according to _ISO 704 Terminology work — Principles and methods_ one of the rules for making definitions is that the term being defined must not be used in the definition to avoid circular definitions. In IFC4.3 there are around 20% circular definitions.
Example 1:
"IfcShadingDeviceType" – "The building element type _IfcShadingDeviceType_ defines commonly shared information for occurrences of shading devices.;"
Example 2:
"IfcStairFlight" – "A stair flight is an assembly of building components..."
Contributor guide
Research direction
Start with the issue examples and the cited ISO 704 Terminology work — Principles and methods guidance. Review the IFC4.3 definitions for terms that repeat the term being defined, documenting the affected entries and the intended wording changes. Done means the identified circular definitions have been revised without introducing new circular references.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100