Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metamodel:: roles missing #2829

Open
5 tasks
taboege opened this issue May 29, 2019 · 1 comment
Open
5 tasks

Metamodel:: roles missing #2829

taboege opened this issue May 29, 2019 · 1 comment
Labels
docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section

Comments

@taboege
Copy link
Member

taboege commented May 29, 2019

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

@JJ
Copy link
Contributor

JJ commented May 29, 2019

Thanks!

@JJ JJ added docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section labels May 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) new part of "docs" - indicates that this documentation is for a new, currently undoc'd section
Projects
None yet
Development

No branches or pull requests

2 participants