search

perlrdf / p5-atteanx-compatibility-trine

Compatibility layer between RDF::Trine and Attean
0 stars 1 forks source link

please provide proper description #1

Open jonassmedegaard opened 6 years ago

jonassmedegaard commented 6 years ago

Current DESCRIPTION section of main POD should ideally serve as introduction to the module, sensible to read standalone - e.g. like the initial paragraph of an encyclopedia entry.

Current DESCRIPTION og AtteanX::Compatilibity::Trine fails in that regard.

Here is a proposed replacement for the DESCRIPTION section (with current content moved to a subsequent section or subsection):

AtteanX::Compatibility::Trine provides a tiny shim for code written for RDF::Trine to instead use Attean. . RDF::Trine and Attean are both Perl frameworks for working with RDF data and SPARQL queries, the former using Moose and deprecated in favor of the latter using Moo. . SPARQL is an RDF query language, that is, a semantic query language for databases, able to retrieve and manipulate data stored in Resource Description Framework format. . Resource Description Framework (RDF) is a standard model for data interchange on the Web.

kjetilk commented 6 years ago

OK, thanks!

Your proposal isn't quite accurate, (like Trine doesn't use Moose to a great extent, though it uses a bit of it, but I'll see about adapting it.

jonassmedegaard commented 6 years ago

Quoting Kjetil Kjernsmo (2017-12-23 21:31:34)

Your proposal isn't quite accurate, (like Trine doesn't use Moose to a great extent, though it uses a bit of it, but I'll see about adapting it.

I am sure you are much better than me in phrasing such text, and look forward to your edits. Just thought you might be helped (or provoked?) by what I had whip together initially for the Debian package :-)

--