OpenAssetIO / OpenAssetIO/OpenAssetIO-TraitGen
Improve usage info in docstrings
Open
Nobody has claimed this yet.
difficulty/easy
enhancement
good first issue
help wanted
task
- Dominant language
- Python
- Stars
- 7
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
What
Improve the docstring generation so that it'd doesn't butt usage up below the last line of the description.
Why
still be presented with standard Host UI for the type as an
option.
* If the "exclusive" property is set to true, then the Manager
takes exclusive control over data with the queried trait set,
and any standard host interfaces etc should be suppressed.
Usage: managementPolicy
Its a bit hard to grok, some whitespace, or moving before the body text might help?
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 at the docstring-generation entry point and reproduce the formatting shown in the issue. Trace how the description and Usage line are assembled, then verify that the generated output separates Usage clearly from the final description line and remains readable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100