potassco / potassco/constraint-handler
It is unclear when statement identifiers should be used
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 20
Description
Currently, some predicates require a statement identifier (e.g., variable_declare(IDENT,VAR,DOMAIN)) and others don't (e.g., variable_domain(VAR,VALUE)). It is hard to guess when an identifier should be provided and when not. Either identifiers should be used in every declaration or there should be some consistent and intentional rules determining when to provide an identifier, and the guidng principles should be documented.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the predicate forms named in the issue, especially variable_declare(IDENT,VAR,DOMAIN) and variable_domain(VAR,VALUE), and compare when statement identifiers are currently used. Determine whether identifiers should be universal or governed by explicit rules. Done means the guiding principles clearly document the intentional choice and explain when an identifier is required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100