cleverlibre/CleverRDFlib
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions 34 Packages Projects Releases Wiki Activity

docs: Initial documentation of CleverRDFLib #5

Merged
CoreRasurae merged 1 commits from docs/initial_documentation-#2 into master 2026-01-28 12:22:35 +00:00
Conversation 2 Commits 1 Files Changed 15
+4097 -42
CoreRasurae commented 2026-01-15 23:05:29 +00:00
Member
Copy Link
Copy Source

ISSUES CLOSED: #2

ISSUES CLOSED: #2
CoreRasurae added 1 commit 2026-01-15 23:05:31 +00:00
docs: Initial documentation of CleverRDFLib
CI / lint (pull_request) Successful in 1m35s
Details
CI / typecheck (pull_request) Successful in 1m38s
Details
CI / behave (3.11) (pull_request) Successful in 1m48s
Details
CI / behave (3.12) (pull_request) Successful in 1m47s
Details
CI / behave (3.13) (pull_request) Successful in 1m43s
Details
CI / build (pull_request) Successful in 1m33s
Details
CI / lint (push) Successful in 1m31s
Details
CI / typecheck (push) Successful in 1m29s
Details
CI / behave (3.11) (push) Successful in 1m37s
Details
CI / behave (3.12) (push) Successful in 1m44s
Details
CI / behave (3.13) (push) Successful in 1m36s
Details
CI / build (push) Successful in 1m31s
Details
f14c0bad8c 
ISSUES CLOSED: #2
CoreRasurae requested review from khird 2026-01-15 23:06:48 +00:00
CoreRasurae requested review from aditya 2026-01-15 23:06:50 +00:00
CoreRasurae self-assigned this 2026-01-15 23:06:56 +00:00
CoreRasurae added the
Type
Documentation
 label 2026-01-15 23:07:11 +00:00
aditya approved these changes 2026-01-22 01:33:46 +00:00
khird approved these changes 2026-01-27 15:23:36 +00:00
khird left a comment
Member
Copy Link
Copy Source

Looks good if a bit overwhelming at first. It might be useful to try and highlight better which should be my priorities to read, as a user. From what I see, that's probably "index", "basic usage", "class hierarchy", and "loading result". But even in "basic usage" it's got advanced stuff about registering custom handlers.

Looks good if a bit overwhelming at first. It might be useful to try and highlight better which should be my priorities to read, as a user. From what I see, that's probably "index", "basic usage", "class hierarchy", and "loading result". But even in "basic usage" it's got advanced stuff about registering custom handlers.
README.md
@@ -24,3 +30,3 @@
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]
pip install -e ."[tests,docs]
khird commented 2026-01-27 14:53:53 +00:00
Member
Copy Link
Copy Source

Is this right? Perhaps there's some subtlety I'm missing but the unbalanced quote looks highly suspicious

Is this right? Perhaps there's some subtlety I'm missing but the unbalanced quote looks highly suspicious
docs/class_hierarchy.md
@@ -0,0 +18,4 @@
## Building the Hierarchy
The class hierarchy is automatically built when you access it:
khird commented 2026-01-27 15:11:05 +00:00
Member
Copy Link
Copy Source

That's a clever way to defer the computation in cases where it might not be used. Is it likely that accessing it can take a long time then? I don't know how much effort the build is - but if that's likely to be very slow compared to a pure access operation, then maybe warn the user here.

That's a clever way to defer the computation in cases where it might not be used. Is it likely that accessing it can take a long time then? I don't know how much effort the build is - but if that's likely to be very slow compared to a pure access operation, then maybe warn the user here.
docs/class_hierarchy.md
@@ -0,0 +166,4 @@
### Datatype Properties
Datatype properties link classes to datatypes:
khird commented 2026-01-27 15:07:11 +00:00
Member
Copy Link
Copy Source

Is "datatypes" a synonym for "built-in types" in this context? It's not especially clear what the allowed range of values is.

Is "datatypes" a synonym for "built-in types" in this context? It's not especially clear what the allowed range of values is.
docs/loading_result.md
@@ -0,0 +366,4 @@
### When to Use Which
- **Use `is_successful_for_main_ontology`** (recommended): When you want to proceed if the main ontology loaded, even if some imports failed
- **Use `is_successful_for_all_ontologies`**: When you require all ontologies (including all imports) to load successfully before proceeding
khird commented 2026-01-27 15:15:35 +00:00
Member
Copy Link
Copy Source

What would be the consequence of proceeding in the case where the main ontology loaded but imports failed? Alternatively, how do I know whether a failed import is likely to break something or can be safely ignored?

What would be the consequence of proceeding in the case where the main ontology loaded but imports failed? Alternatively, how do I know whether a failed import is likely to break something or can be safely ignored?
CoreRasurae merged commit f14c0bad8c into master 2026-01-28 12:22:35 +00:00
CoreRasurae deleted branch docs/initial_documentation-#2 2026-01-28 12:22:36 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
aditya
khird
Labels
Clear labels
Blocked
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
Needs feedback
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Signed-off: Owner
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
 Signed-off: Scrum Master
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
 Signed-off: Tech Lead
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
 Spike
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
No Label
Type
Documentation
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
aditya (Aditya Chhabra) aleenaumair (Aleena Umair) CoreRasurae (Luis Mendes) freemo (Jeffrey Phillips Freeman) hamza.khyari (Hamza Khyari) khird (Kyle Hird) mngrif (Michael Griffith) salcedo (Brian Salcedo)
No Assignees CoreRasurae
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cleverlibre/CleverRDFlib#5
Delete Branch "docs/initial_documentation-#2"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?