Metamodel:: roles missing
Nobody has claimed this yet.
- Dominant language
- Raku
- Stars
- 308
- Forks
- 288
- Avg merge
- 3d 49m
- Merged PRs (30d)
- 2
Description
The problem
The HOW types, look for instance at EnumHow, do a lot of roles and not all of them are documented, as can already be seen from them not appearing in the table of contents of the HOW type.
- Metamodel::Documenting
- Metamodel::Stashing
- Metamodel::Mixins
- Metamodel::MultiMethodContainer
- what else?
Suggestions
Complete the list above and then document them. I suppose that the line between "documentable" and "utter implementation detail" is especially thin here, so that might have to be decided on a per-case basis. I would argue that Documenting and MultiMethodContainer are documentable.
References
Seems to be a continuation of #1306
Contributor guide
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 the EnumHow documentation and inspect the roles listed in the issue: Metamodel::Documenting, Metamodel::Stashing, Metamodel::Mixins, and Metamodel::MultiMethodContainer. Determine which roles are documentable rather than implementation details, complete the role list, and update the relevant HOW documentation so the chosen roles appear in its table of contents.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100