search

software-challenge / backend

Server, Client und Spiel-Plugins der Software-Challenge Germany
https://www.software-challenge.de
11 stars 10 forks source link

Wrong parameter name in documentation #203

Closed TiLuHa closed 5 years ago

TiLuHa commented 5 years ago

In der Dokumentation zum Test-Client steht, dass die Namen der Attribute für die Timeouts "--timeout1" und "--timeout2" heißen. Der richtige Name lautet jedoch "--no-timeout1" bzw. "--no-timeout2"

matthesjh commented 5 years ago

@TiLuHa Vielen Dank für den Hinweis! Da wurde wohl vergessen, die Dokumentation zu aktualisieren.

matthesjh commented 5 years ago

@Xerus2000 Du hast mit 43977f6 die Namen der Argumente verändert. Ich würde diese Namensänderung allerdings wieder rückgängig machen, da für mich der Präfix no- bei dieser booleschen Option nicht viel Sinn ergibt. Es ist eher verwirrend.

Was denkst du?

xeruf commented 5 years ago

Doch, das hat den Sinn, dass man boolesche Optionen nur angeben oder nicht angeben kann. Und standardmäßig sollten beide ja timeouten. Ich dachte ja erst dass man dann --timeout1 false angibt, aber das geht so nicht. Daher habe ich es andersrum gemacht.

matthesjh commented 5 years ago

Alles klar! Ich wusste nicht, dass bei booleschen Optionen keine nachfolgenden Werte angegeben werden können. Damit ergibt das für mich auch Sinn. Die Dokumentation sollte dann aber entsprechend geändert werden.