microsoft / microsoft/ifc-spec
IFC Padding Documentation is Inconsistent
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 94
- Forks
- 11
- Avg merge
- 1d 29m
- Merged PRs (30d)
- 2
Description
So as @AndreyG points out in #84, the IFC's documentation for padding is currently inconsistently specified. This is further complicated by #78 where interior padding is featured.
I'd suggest either specifying all instances of padding (as is done for TypeSort::Fundamental and Words), or specifying the rules for padding.
The former is a burden on specification, and the latter can be a burden (or easing of) implementation (depending on the design). The latter would (in my mind) require as a prerequisite that the IFC never use interior padding (as in #78), or have very specific rules about when this happens.
Contributor guide
No contributing guide indexed for this repository
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 padding descriptions for TypeSort::Fundamental and Words with the other IFC documentation. Review the concerns in issues #84 and #78, especially the question of interior padding. Done means the specification consistently lists padding instances or defines rules that resolve the interior-padding case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100