core.logic

Add documentation strings to stable functions

Details

  • Type: Task Task
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Completed
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None

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
  1. 0001-Added-docstrings.patch
    20/Jul/11 9:08 AM
    3 kB
    Ambrose Bonnaire-Sergeant
  2. 0001-Added-docstrings.patch
    18/Jul/11 11:47 AM
    3 kB
    Ambrose Bonnaire-Sergeant

Activity

Hide
David Nolen added a comment -

fixed

Show
David Nolen added a comment - fixed
Hide
Ambrose Bonnaire-Sergeant added a comment -

Yes, can be closed

Show
Ambrose Bonnaire-Sergeant added a comment - Yes, can be closed
Hide
David Nolen added a comment -

I'm assuming this ticket is no longer relevant?

Show
David Nolen added a comment - I'm assuming this ticket is no longer relevant?
Hide
Ambrose Bonnaire-Sergeant added a comment -

Should we document succeed and fail?

I'm not pleased with my wording on llist.

Show
Ambrose Bonnaire-Sergeant added a comment - Should we document succeed and fail? I'm not pleased with my wording on llist.
Hide
Ambrose Bonnaire-Sergeant added a comment -

Second iteration

Show
Ambrose Bonnaire-Sergeant added a comment - Second iteration
Hide
David Nolen added a comment -

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.

Show
David Nolen added a comment - 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.
Hide
Ambrose Bonnaire-Sergeant added a comment -

I thought unify was a relation, not a goal?

Show
Ambrose Bonnaire-Sergeant added a comment - I thought unify was a relation, not a goal?
Hide
David Nolen added a comment - - edited

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*.

Show
David Nolen added a comment - - edited 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*.
Hide
Ambrose Bonnaire-Sergeant added a comment -

Docstrings for relational functions.

Show
Ambrose Bonnaire-Sergeant added a comment - Docstrings for relational functions.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: