docs icon indicating copy to clipboard operation
docs copied to clipboard

Bei Code-Beispielen Dummy-Output mit angeben

Open alxndr-w opened this issue 7 years ago • 6 comments

So bekommt man einen konkreten Eindruck davon, was eine Klasse macht.

Denn wieder Helmut Kohl einst sagte:

Entscheidend ist, was hinten rauskommt.

Aufgefallen bei rex_list und rex_form, könnte aber auch andere Teile der Doku betreffen. bspw. hier https://redaxo.org/doku/master/listen

alxndr-w avatar Oct 08 '17 22:10 alxndr-w

@alexplusde Was meinst Du denn genau? Da sind doch Beispiele drin, wie man beispielsweise ien Liste ausgibt?

polarpixel avatar Oct 09 '17 06:10 polarpixel

den Ausgabe-Code.

Da steht bspw.

$list = rex_list::factory('SELECT name,vorname,plz,ort,telefon FROM rex_adressen');
$list->show();

Aber was für HTML wird da jetzt erzeugt?

alxndr-w avatar Oct 09 '17 12:10 alxndr-w

Aber was für HTML wird da jetzt erzeugt?

das html kann und wird sich mit redaxo versionen ändern (es ist daher sehr aufwändig zu pflegen). es ist sehr umfangreich und es in die doku reinzubringen hat keinen mehrwert?

staabm avatar Oct 09 '17 12:10 staabm

@alexplusde Meinst du jetzt eher einen Screenshot oder das tatsächliche HTML im Quelltext?

tbaddade avatar Oct 09 '17 12:10 tbaddade

Dann in dem Fall wohl eher einen Screenshot. Prinzipiell aber eben etwas, aus dem deutlich hervorgeht, was einen konkret erwartet.

alxndr-w avatar Oct 09 '17 13:10 alxndr-w

das html kann und wird sich mit redaxo versionen ändern (es ist daher sehr aufwändig zu pflegen). Es ist sehr umfangreich und es in die doku reinzubringen hat keinen mehrwert?

Ich sehe das nicht so. Im Gegenteil: Wenn sich etwas ändert, ist es wichtig, das mit in der Doku festzuhalten.

alxndr-w avatar May 08 '20 14:05 alxndr-w