search

SWI-Prolog / packages-pengines

Pengines: Prolog engines
11 stars 13 forks source link

Inconsistent and unexplained terminology #32

Closed triska closed 6 years ago

triska commented 6 years ago

Please compare for example the descriptions of pengine_input/2 and pengine_respond/3:

One "Sends Prompt to the parent pengine", the other "Sends a response ... to a slave pengine that has prompted its master for input".

In pengine_create/1, we find that "slave pengine" is synonymous with "child", but nowhere is it mentioned that "master" is (presumably) synonymous with "parent".

If possible, please use consistent terminology, or at least explain the terminology up front. Thank you!

torbjornlager commented 6 years ago

Thanks! To consistently use one pair of terms over the other would have introduced a LOT of changes in either pendoc.md or in pengines.pl so we explained that the master/slave and parent/child are synonyms and also added clarifying text in the docs for pengine_input/2 and pengine_respond/3.

triska commented 6 years ago

Thank you! I consider this suboptimal.