Class and function documentation #333
Conversation
| """ | ||
| Main functionalities: | ||
| The Xor class is a subclass of the GlobalConstraint class and represents the exclusive-or constraint. It takes a list | ||
| of Boolean arguments and enforces that exactly one of them is true. |
There was a problem hiding this comment.
This is not quite correct: "xor" is true iff the number of true variables in the given list is odd (with only two arguments, xor is indeed equivalent to 'exactly one is true', but we allow more).
| """ | ||
| Main functionalities: | ||
| The Element class is a CPMpy built-in global constraint that enforces that the result equals Arr[Idx] with 'Arr' an | ||
| array of constants of variables (the first argument) and 'Idx' an integer decision variable, representing the index into |
There was a problem hiding this comment.
'of variables' -> 'or variables'
There was a problem hiding this comment.
I think 'Idx' is not a "decision variable", but can ben any integer expression.
|
I both like and hate this: it is 95% correct, and figuring out where it is incorrect is time consuming. I'd allow this if we put an "AI-generated"-tag next to it. People can remove that tag once they checked it manually. It reminds me of why StackOverflow forbade the use of AI-generated answers: it looks correct, but figuring out whether it is correct is hard. |
Having basic documentation of the functionality of classes and functions would be quite nice.
Following discussions in person, I generated automatically documentation starting for the global constraint classes. The documentation was auto generated using codiumAI (pycharm extention).
Let's see if it is good enough and if yes we can proceed with more functions and classes.
In the first commit, only the text generated automatically is included. In following commits I will check the texts and maybe change some parts if needed