Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sdcondon committed Oct 7, 2022
1 parent f174445 commit 503ebee
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/user-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ using Action = SCClassicalPlanning.Action; // an unfortunate clash with System.A
// Our domain refers to a single constant - the table on which our blocks are placed:
Constant Table = new(nameof(Table));

// Our domain defines four predicates (essentially, facts about zero or more elements of the domain that can either hold true or not):
// As mentioned in the user guide for SCFirstOrderLogic, creating helper methods for your predicates is highly recommended.
// Note that we're using OperablePredicate here. Its not required, but makes everything nice and succinct because it
// means we can use & and ! to combine them. See the SCFirstOrderLogic docs for details.
// Our domain defines four predicates (essentially, facts about zero or more elements of the domain that,
// in any given state, are either true or not. As mentioned in the user guide for SCFirstOrderLogic, creating
// helper methods for your predicates is highly recommended. Note that we're using OperablePredicate here.
// Its not required, but makes everything nice and succinct because it means we can use & and ! to combine them.
// See the SCFirstOrderLogic docs for details.
OperablePredicate On(Term above, Term below) => new Predicate(nameof(On), above, below);
OperablePredicate Block(Term block) => new Predicate(nameof(Block), block);
OperablePredicate Clear(Term surface) => new Predicate(nameof(Clear), surface);
Expand Down

0 comments on commit 503ebee

Please sign in to comment.