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

Internal data types are not linked in monarch-py documentation #894

Open
ptgolden opened this issue Nov 15, 2024 · 0 comments
Open

Internal data types are not linked in monarch-py documentation #894

ptgolden opened this issue Nov 15, 2024 · 0 comments

Comments

@ptgolden
Copy link
Member

While working on #820, I noticed something fishy with the monarch-py documentation. In the Python documentation generated by mkdocstrings, internal monarch-py classes listed as function parameters and return values are not linked to any documentation. For example, in the documentation for get_associations, there is no hint what AssociationCategory, AssociationPredicate, AssociationResult, or CompactAssociation are. Some (but not all) of these have applicable LinkML documentation (e.g. https://monarch-app.monarchinitiative.org/Data-Model/CompactAssociation/).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant