potassco / potassco/constraint-handler

Documentation - make clearer difference between conditional execution `if` and logical implication `limp`

Open Beginner friendly
#216 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3
Forks
0
Avg merge
1d 19h
Merged PRs (30d)
20

Description

I think it might be useful to highlight more clearly in constraint_handler/reference/execution/#if that the if/3 operator is not a logical operator. Perhaps could add a link to point the user to the logical implication operator limp.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the documentation at constraint_handler/reference/execution/#if and review how the if/3 operator is described. Clarify that if/3 is not a logical operator and add a link to the logical implication operator limp. Done when the distinction and cross-reference are clear to readers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.