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

Update slot cardinality meaning on main linkml docs site #2100

Merged
merged 3 commits into from
May 10, 2024

Conversation

sujaypatil96
Copy link
Member

Update the current description shown here: https://linkml.io/linkml/schemas/slots.html#slot-cardinality to capture the latest description of cardinality according to the method definition here: https://github.com/linkml/linkml/blob/main/linkml/generators/docgen.py#L567-L623

@sujaypatil96 sujaypatil96 requested a review from cmungall May 7, 2024 23:38
Copy link

codecov bot commented May 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.88%. Comparing base (0440402) to head (af82ab2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2100   +/-   ##
=======================================
  Coverage   79.88%   79.88%           
=======================================
  Files         109      109           
  Lines       12249    12249           
  Branches     3489     3489           
=======================================
  Hits         9785     9785           
  Misses       1874     1874           
  Partials      590      590           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


The cardinality of a slot in UML class diagrams indicates the number of instances of one class
that can be linked to an instance of another class. Cardinality (sometimes also referred to as
*multiplicity*) notations are placed near the end of an association.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...placed near the end of an association" - did this come from UML documentation. I think this is fine for UML documentation but you need to place it in more context here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pieced it together from some UML docs and mermaid docs. But yes, you're right it would be helpful to clarify what "association" means in this context.

@sujaypatil96 sujaypatil96 requested a review from cmungall May 9, 2024 20:55
@sujaypatil96 sujaypatil96 merged commit 1f218e4 into main May 10, 2024
14 checks passed
@sujaypatil96 sujaypatil96 deleted the slot-cardinality-docs branch May 10, 2024 00:06
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

Successfully merging this pull request may close these issues.

None yet

2 participants