Verständnissfrage zum Board Ankündigungen

[Joachim]

Moin @ all,

nachdem ich nun schon das eine oder andere "Fettnapf" getroffen habe,
habe mal eine Frage, um den nächsten "Fettnapf zu entgehen.

Darf man im Board Ankündigungen außer zur Ankündigung eines neuen Moduls auch weitere Eintragungen, z.B. bei Änderungen am Modul, Erweiterungen in englisch einfügen?
Meine Idee war, den ersten Post immer aktuell zu halten, und wenn ich die Zeit dazu finde, ihn auch zweisprachig (EN/DE) zu machen, und Nachträge, Erweiterungen, Beispiele zum Verständniss eines Moduls als neue Posts einzustellen.

Das hättte den Vorteil,
- dass man viel detaillierter auf ein Modul eingehen könnte als wie in der commandref
- man bei Fragen zum Modul auf die Beispiele unter Ankündigungen verweisen könnte
- es übersichtlicher wäre, da eigentlich nur der Modulautor den Tread verändern sollte
- generelle Probleme, die sich im dazugehörigen Diskussionstread ergeben, hier mit einem allgemeinen Beispiel lösen könnte
- bei Änderungen am Modul mit Eintrag im Ankündigungstread dieser wieder als neu angezeigt wird, und damit auffälliger ist

Zweite Frage zu commandref_join.pl
Würde es nicht Sinn machen, zusätzlich zu der Kontrolle "Unbalanced ul" zu Kontrollieren, ob alle  geöffneten <xx> auch wieder geschlossen wurden?
Damit sich der Fehler von mir nicht wiederholt. Vorrausgesetzt der Modulautor nutzt die commandref_join.pl.

Gruß Joachim

[rudolfkoenig]

Ankuendigungen sollte nur wenig Beitraege beinhalten, die grundlegende Aenderungen/Neuerungen beschreiben, oder die von allgemeiner Interesse sind. Wenn man ein Modul detaillierter dokumentieren will mit detaillierten Beispielen und Geschichten, dann sollte man fhemwiki verwenden.

commandref_join.pl
- bitte beachten, dass (mWn) in HTML nicht alle Tags geschlossen sein muessen
- ich bin bereit einen passenden Patch zu integrieren
- es waere mAn besser die bereits existierenden Regeln zu erzwingen (siehe meine Anfrage zu svn-pre-commit-hooks), als weitere zu erfinden.
Die Ausgaben vom commandref_join.pl sind nur als Hilfe gedacht, der Entwickler sollte  eigentlich das fertige Dokument selbst kontrollieren. Leider wird das regelmaessig vergessen, und ich will damit nicht sagen, dass ich besser bin als andere.

[Joachim]

Hallo Rudi,

Wenn man ein Modul detaillierter dokumentieren will mit detaillierten Beispielen und Geschichten, dann sollte man fhemwiki verwenden.

ich hab's befürchtet, kann es allerdings auch verstehen. Mein Vorschlag wäre halt für mich einfacher gewesen, und hätte die oben beschriebenen Vorteile gehabt, kann allerdings auch mit der Wiki-Variante leben.

Der Fehler mit dem fehlenden </b> war mir nicht aufgefallen, da es ausgerechnet der letzte Satz war, und ich mir die nachfolgende Beschreibung nicht mehr angesehen hatte. Schande über mich, das wird mir hoffentlich kein zweites mal passieren.
Das mit den svn-pre-commit-hooks werde ich mir ansehen.

Die Ausgaben vom commandref_join.pl sind nur als Hilfe gedacht, der Entwickler sollte  eigentlich das fertige Dokument selbst kontrollieren.

so hatte ich das verstanden, aber grerade bei der commanref habe ich gar keine Ahnung, was da passiert, da mache ich nur den Guttenberg.

Gruß Joachim

[betateilchen]

Der Fehler mit dem fehlenden </b>
...
wird mir hoffentlich kein zweites mal passieren.

Nun krieg dich mal wieder ein, es war überhaupt nicht Dein Fehler, sondern meiner. Denn der Fehler war in der englischsprachigen Doku und die stammt von mir.

[Joachim]

Ok,

betateilchen war's