search

pchampin / sophia_rs

Sophia: a Rust toolkit for RDF and Linked Data
Other
210 stars 23 forks source link

Inline `sophia` documentation for reexported modules #171

Open mkatychev opened 1 week ago

mkatychev commented 1 week ago

Current https://docs.rs/sophia/latest/sophia/ does not reexport documentation for workspace crates making documentation navigation a bit cumbersome. This PR calls #[doc(inline)] to re-export documentation: https://github.com/pchampin/sophia_rs/blob/a5cca57cfad8aab51a31b24468068389b1d6616b/sophia/src/lib.rs#L27-L45

pchampin commented 3 days ago

Any reason for not including sophia_turtle, sophia_jsonld and sophia_xml?

mkatychev commented 2 days ago

Any reason for not including sophia_turtle, sophia_jsonld and sophia_xml?

None other than to trigger a conversation about whether everything should be included. I'll make the changes.

pchampin commented 2 days ago

None other than to trigger a conversation about whether everything should be included. I'll make the changes.

IIUC, the main benefit of inlining the documentation is to allow to search all re-exported crates in one place. I think users would be surprised if only a subset of these crates was showing in the search results...