buildingSMART / buildingSMART/IFC4.x-development

Attribute/property/enum descriptions shouldn't have line-breaks

Open
#719 0 comments 0 reactions 0 assignees View on GitHub
after-NWI iso-Ed
Dominant language
Python
Stars
234
Forks
123
Avg merge
15h 4m
Merged PRs (30d)
5

Description

I found some descriptions containing random `\n` in them, should probably remove all of them:
> 'Allows for specification of user defined roles beyond the\nenumeration values provided by Role attribute of type IfcRoleEnum.\nWhen a value is provided for attribute UserDefinedRole in parallel\nthe attribute Role shall have enumeration value USERDEFINED.'

Contributor guide

Open the contributing guide

Research direction

The issue names no file, test, or entry point. Start by locating the source data for IFC attribute, property, and enum descriptions, then search it for embedded line breaks like the quoted example. Done means the affected descriptions no longer contain unintended line breaks while their wording remains unchanged.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.