emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/triples 1112c57419: Add information about when triples


From: ELPA Syncer
Subject: [elpa] externals/triples 1112c57419: Add information about when triples package is a good idea
Date: Fri, 2 Feb 2024 00:58:47 -0500 (EST)

branch: externals/triples
commit 1112c57419edfd14eb6f7ad523c320ed7a377d7b
Author: Andrew Hyatt <ahyatt@gmail.com>
Commit: Andrew Hyatt <ahyatt@gmail.com>

    Add information about when triples package is a good idea
    
    Also, call it a package instead of a module.
    
    Also note that our example subject names are not really appropriate in real 
use.
    
    Further fixes to https://github.com/ahyatt/triples/issues/6.
---
 README.org | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.org b/README.org
index 47fcc71649..b08f6de3cf 100644
--- a/README.org
+++ b/README.org
@@ -1,6 +1,8 @@
 #+TITLE: Triples
 
-The =triples= module is a standard database module designed for use in other 
emacs modules.  It works with either the builtin sqlite in Emacs 29 or the 
[[https://github.com/magit/emacsql][emacsql]] module, and provides a simple way 
of storing entities and their associated schema.  The triples module is well 
suited to graph-like applications, where links between entities are important.  
The module has wrappers for most common operations, but it is anticipated that 
occasionally client modu [...]
+The =triples= package is a standard database package designed for use in other 
emacs modules.  It works with either the builtin sqlite in Emacs 29 or the 
[[https://github.com/magit/emacsql][emacsql]] package, and provides a simple 
way of storing entities and their associated schema.  The triples package is 
well suited to graph-like applications, where links between entities are 
important.  The package has wrappers for most common operations, but it is 
anticipated that occasionally client [...]
+
+This package is useful for simple applications that don't want to write their 
own SQL calls, as well as more complicated applications that want to store many 
different kinds of objects without having to set up and manage a variety of 
tables, especially when there is a graph-like relationship between the 
entities.  It also is suited for applications where different packages want to 
store different data about the same set of entities, or store the same data 
about very different sets of ent [...]
 
 * Installing
 This module is available through GNU ELPA, and can be installed as normal.  
However, most of the time this module is only useful in concert with another 
module which uses it as a library and will declare it as a dependency, so 
unless you are planning on developing with it, there is usually no need to 
install it directly.
@@ -81,6 +83,8 @@ Which returns
 '(:manager "bob" :reportees '("catherine" "dennis"))
 #+end_src
 
+Note that these subject names are just for demonstration purposes, and 
wouldn't make good subjects because they wouldn't be unique in practice.  See 
[[file:triples-design.org][our document on triples design]] for more 
information.
+
 There are other useful functions, including:
 - =triples-get-types=, which gets all the types a subject has,
 - =triples-delete-subject=, which deletes all data associated with a subject,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]