Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Improve the documentation for Classes #1685

Closed
nicholascar opened this issue Jan 23, 2022 · 5 comments
Closed

Improve the documentation for Classes #1685

nicholascar opened this issue Jan 23, 2022 · 5 comments

Comments

@nicholascar
Copy link
Member

In the Tern class hierarchy, these classes need better docstrings so they can be understood:

  • Node
  • Identifier
  • Genid (none)
  • RDFLibGenid (node)
  • Variable
@aucampia
Copy link
Member

Suggestion for Variable docstring here:

@nicholascar
Copy link
Member Author

I wonder what Genid and RDFLibGenid are even used for? I'll have to search the codebase as I've never come across them using RDFLib!

@aucampia
Copy link
Member

I wonder what Genid and RDFLibGenid are even used for? I'll have to search the codebase as I've never come across them using RDFLib!

If memory serves, then one is for generating blank node identifiers and the other is not used, but I may be wrong about it and I can't recall which is which.

@edmondchuc
Copy link
Contributor

edmondchuc commented Jan 24, 2022

I wonder what Genid and RDFLibGenid are even used for?

They are used for skolemization and de-skolemization of blank nodes. I remember writing a brief explanation in this PR #1493

@nicholascar
Copy link
Member Author

Thanks for the reminder @edmondchuc!

@ghost ghost locked and limited conversation to collaborators Mar 9, 2022
@ghost ghost converted this issue into discussion #1756 Mar 9, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants