Ludii Forum
Feedback on the documentation - Printable Version

+- Ludii Forum (https://ludii.games/forums)
+-- Forum: Questions (https://ludii.games/forums/forumdisplay.php?fid=13)
+--- Forum: About the Ludii Grammar (https://ludii.games/forums/forumdisplay.php?fid=15)
+--- Thread: Feedback on the documentation (/showthread.php?tid=275)

Pages: 1 2

Feedback on the documentation - slimy_asparagus - 11-21-2020

Here are my observations on the documentation so far:

Language Reference

p.112 According to the text "move Swap" is about deciding to remove components.

p.193 The section on "mapEntry" would really benefit from a suggestion to see the section on "map" (p.55)

Game Logic Guide

p.17 The word "contrary" is used incorrectly at the bottom of the page. Instead of


Quote:A decision move is the move decided by the player contrary to an effect move which is applied following a decision.
should read



Quote:A decision move is the move decided by the player as opposed to an effect move which is applied following a decision.
I guess you're not got to believe me on that one. I tried to find a good source. All I could find was people being puzzled about the difference. My sense is that the former says the two moves are contradictory (e.g. science being contrary to religion); the latter says the two are different (e.g. The Revolutionary Communist Party (as opposed to Socialists in general).....)


p. 48 "To iterate through group of pieces...." should read "To iterate through groups of pieces...."

p.49 "To iterate between two integers...." should read "To iterate over a range of integers....."

RE: Feedback on the documentation - Eric Piette - 11-23-2020

Hi,

Thanks a lot for these corrections. I applied them and updated the documents.

Regards,
Eric

RE: Feedback on the documentation - Michael - 11-26-2020

Here is a piece of feedback on the Language Reference:
The ludeme (apply) seems to have some hidden default "if"-condition condition which it would be nice if were made explicit. The language reference is usually very clear on such things, but in the case of this ludeme no default value is stated.

I figured this out when trying to remove a neutral piece at the (to)-location. In the attached .lud the neutral piece is not removed when making the following move:
Code:
(define "MoveOntoNeutral"
    (move
        (from)
        (to
            (sites Direction
                from:(from)
            )
            (apply (remove (to)))
        )
        stack:true
    )
)
But it works if I add "if:true" or "if:(= 0 (who at:(to)))" to (apply), like this:
Code:
(define "MoveOntoNeutral"
    (move
        (from)
        (to
            (sites Direction
                from:(from)
            )
            (apply if:true (remove (to)))
        )
        stack:true
    )
)


RE: Feedback on the documentation - Eric Piette - 11-27-2020

Hi,

The ludeme (apply ...) used alone is working as you expect. If no condition, the effect is applied.

However when used inside other ludemes such as the (fromTo ...), its used can be different according to where it is used.
For the case you found, that's was a problem in the code. In the version you have if no condition is specified in the (apply ...) in the (to ...) of a (fromTo ...) or (move ...) the effect was not applied.
I just fixed it in our dev version to be applied if no condition is specified.

If you see others such cases, thanks by advance to advert us :)

Regards,
Eric

RE: Feedback on the documentation - Michael - 11-30-2020

I can’t see that it says anywhere whether the integer function (div) rounds up or down in case the result involves a fraction. That could be good to add :)

RE: Feedback on the documentation - Eric Piette - 11-30-2020

Hi,

Ok I will add that to our doc.

Regards,
Eric

RE: Feedback on the documentation - slimy_asparagus - 11-30-2020

Language Reference

section 6.10.4

The sentence "The other list of legal moves if the condition is not satisfy." should read "The other list of legal moves if the condition is not satisfied."

RE: Feedback on the documentation - Eric Piette - 12-01-2020

Hi,

Thanks.

Regards,
Eric

RE: Feedback on the documentation - slimy_asparagus - 12-07-2020

In the 1.1.7 version of the documentation talks about the function that was just added:

Code:
For creating a region with specific sites.(sites ({<int>}| <intArrayFunction>))
This is confusing because it sounds like the previously existing function that creates a region from a list of coordinates. I think it might be better to change the text to



Quote:
Code:
For creating a region from a list of site indices.


RE: Feedback on the documentation - Eric Piette - 12-07-2020

Hi,

Ok I will adapt the documentation, but that function is not new and was already there before. The only modification is to also take in entry an IntArrayFunction, which is not a list of site indices, but return a list of integers which will be converted to list of indices to create the region.

Regards,
Eric