OpenAssetIO / OpenAssetIO/OpenAssetIO-TraitGen
Code generation improvements
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
What
Following on from discoveries and discussions as part of #11
Tasks
- [Tests][C++][Python] Test copyright headers added to all generated files
- [Tests][C++][Python] Add missing tests of hoisting header/module docstrings
- [Tests][C++][Python] Ensure long docstrings are wrapped appropriately
- [Core][C++][Python] Choose/create exception type(s) raised when trait property not available
- [Core][C++][Python] Factor out common utility code
- [Tests][Python] Test behaviour when requesting trait property of non-imbued trait
- [Core][Python] Validate module names
- [Core][Python] Do not duplicate "Conforming" warnings
- #19
- https://github.com/OpenAssetIO/OpenAssetIO-TraitGen/issues/10
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 reading the discoveries and discussions in #11, then review the unchecked tasks in this issue and the referenced issue #10. No files or test paths are named, so locate the generator's C++ and Python output code and related tests before beginning. Done means the remaining checklist items are implemented and verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- testing-qa, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 22/100