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

[ENH] Ontology widget documentation #881

Merged
merged 2 commits into from
Jul 19, 2022

Conversation

PrimozGodec
Copy link
Collaborator

Issue

The ontology widget is missing the documentation

Description of changes

Add documentation for the ontology widget

Includes
  • Code changes
  • Tests
  • Documentation

@ajdapretnar
Copy link
Collaborator

I was planning to do this, but not before Ontology is a bit more stable. For instance, #832 and #824.


The ontology widget enables various operations with ontologies:
- Generate ontology from words on the input
- Load existing ontology from a file or URL
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add which formats are supported.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2022

Codecov Report

Merging #881 (a8d49b0) into master (60bc8ff) will decrease coverage by 0.02%.
The diff coverage is n/a.

❗ Current head a8d49b0 differs from pull request most recent head 9f2aa2a. Consider uploading reports for the commit 9f2aa2a to get more accurate results

@@            Coverage Diff             @@
##           master     #881      +/-   ##
==========================================
- Coverage   76.97%   76.94%   -0.03%     
==========================================
  Files          85       85              
  Lines       11954    11960       +6     
  Branches     1877     1881       +4     
==========================================
+ Hits         9201     9203       +2     
- Misses       2449     2451       +2     
- Partials      304      306       +2     

@PrimozGodec
Copy link
Collaborator Author

I was planning to do this, but not before Ontology is a bit more stable. For instance, #832 and #824.

I started to work on it since on MJU they said that they need it to finish the project.
Regarding the issues:
#832 - this one is a really difficult one since it is caused by some unexpected behaviour by PyQT. I will continue working on it but haven't had enough time yet.
#824 - is also waiting because of me not having enough time

@PrimozGodec
Copy link
Collaborator Author

Before we merge it, I would just as @djukicn to:

  • add a short sentence of the score in point 5
  • check whether information regarding the generation of the ontology is correct
  • Maybe add some additional information on how ontologies are generated

@ajdapretnar
Copy link
Collaborator

@PrimozGodec I am sorry I didn't check this yesterday, but you need to add ontology.md to index.rst and re-create widgets.json.

@ajdapretnar ajdapretnar merged commit b5aa6c1 into biolab:master Jul 19, 2022
@PrimozGodec PrimozGodec deleted the ontology-docs branch March 29, 2023 10:36
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.

4 participants