INCATools / INCATools/dead_simple_owl_design_patterns
Document pattern_name as Human Readable
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 49
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
I would like to propose to repurpose pattern_name as being human readable. The field is used by no process that I know off, but our documentation pages suffer from ugly titles: https://github.com/geneontology/go-ontology/blob/master/docs/patterns/activator_activity.md
@dosumis @cmungall @balhoff
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 with docs/patterns/activator_activity.md and inspect how its pattern_name value becomes the page title. Check the repository’s pattern_name usage before deciding whether it can be made human-readable without affecting existing processes; done means the documentation title is readable and current users of the field still work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100