<< Back to previous view

[LOGIC-10] Add documentation strings to stable functions Created: 14/Jul/11  Updated: 28/Jul/13  Resolved: 20/Nov/11

Status: Closed
Project: core.logic
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Trivial
Reporter: Ambrose Bonnaire-Sergeant Assignee: David Nolen
Resolution: Completed Votes: 0
Labels: None

Attachments: Text File 0001-Added-docstrings.patch     Text File 0001-Added-docstrings.patch    

 Description   

Candidates:

clojure.core.logic.minikanren

  • ==
  • conde
  • exist
  • run
  • run*
  • lvar, lvar?
  • lcons, lcons?
  • llist

clojure.core.logic.prelude:

  • nilo, emptyo, conso, firsto, resto, membero

clojure.core.logic.nonrel:

  • project
  • lvaro, nonlvaro


 Comments   
Comment by Ambrose Bonnaire-Sergeant [ 18/Jul/11 11:47 AM ]

Docstrings for relational functions.

Comment by David Nolen [ 20/Jul/11 6:59 AM ]

I'd rather not document lvar/lvar?. They are not really meant to be used directly. The docstring of lcons should be changed to say that it constructs a sequence a with an improper tail if d is a logic variable. llist should read similarly.

unify should probably say "a goal which attempts to unify u and v". Goals do not return "successful" or "failed" goals. They themselves either succeed or fail.

For exist we should probably rename x-rest to lvars and g-rest to goals. In run rename rest to goals, ditto for run*.

Comment by Ambrose Bonnaire-Sergeant [ 20/Jul/11 7:07 AM ]

I thought unify was a relation, not a goal?

Comment by David Nolen [ 20/Jul/11 7:10 AM ]

There is no difference between "relation" and "goal". conso is the relational counterpart to cons - it is most definitely a goal. It will either fail or succeed based on other elements in a particular miniKanren program.

Comment by Ambrose Bonnaire-Sergeant [ 20/Jul/11 9:08 AM ]

Second iteration

Comment by Ambrose Bonnaire-Sergeant [ 20/Jul/11 9:09 AM ]

Should we document succeed and fail?

I'm not pleased with my wording on llist.

Comment by David Nolen [ 20/Nov/11 3:20 PM ]

I'm assuming this ticket is no longer relevant?

Comment by Ambrose Bonnaire-Sergeant [ 20/Nov/11 3:37 PM ]

Yes, can be closed

Comment by David Nolen [ 20/Nov/11 3:38 PM ]

fixed

Generated at Wed Oct 01 03:35:56 CDT 2014 using JIRA 4.4#649-r158309.