docs: Initial documentation of CleverRDFLib #5

Merged
CoreRasurae merged 1 commit from docs/initial_documentation-#2 into master 2026-01-28 12:22:35 +00:00
Member

ISSUES CLOSED: #2

ISSUES CLOSED: #2
docs: Initial documentation of CleverRDFLib
All checks were successful
CI / lint (pull_request) Successful in 1m35s
CI / typecheck (pull_request) Successful in 1m38s
CI / behave (3.11) (pull_request) Successful in 1m48s
CI / behave (3.12) (pull_request) Successful in 1m47s
CI / behave (3.13) (pull_request) Successful in 1m43s
CI / build (pull_request) Successful in 1m33s
CI / lint (push) Successful in 1m31s
CI / typecheck (push) Successful in 1m29s
CI / behave (3.11) (push) Successful in 1m37s
CI / behave (3.12) (push) Successful in 1m44s
CI / behave (3.13) (push) Successful in 1m36s
CI / build (push) Successful in 1m31s
f14c0bad8c
ISSUES CLOSED: #2
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

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.
@ -24,3 +30,3 @@
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]
pip install -e ."[tests,docs]
Member

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
@ -0,0 +18,4 @@
## Building the Hierarchy
The class hierarchy is automatically built when you access it:
Member

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.
@ -0,0 +166,4 @@
### Datatype Properties
Datatype properties link classes to datatypes:
Member

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.
@ -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
Member

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 deleted branch docs/initial_documentation-#2 2026-01-28 12:22:36 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleverlibre/CleverRDFlib!5
No description provided.