FHEM Forum

FHEM - Entwicklung => FHEM Development => Thema gestartet von: krikan am 09 März 2018, 18:06:50

Titel: Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 09 März 2018, 18:06:50
In der commandref fehlt bei einigen Modulen noch die 2016 eingeführte "short description" (https://wiki.fhem.de/wiki/Guidelines_zur_Dokumentation#Kurzbeschreibung_des_Moduls).

In diesem Thread werde ich in der nächsten Zeit Patches zur Ergänzung der Kurzbeschreibungen hochladen.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 09 März 2018, 18:14:03
Anhängend Patch-Vorschläge für FHEM commands ohne Kurzbeschreibung bzw. Tippfehlern:

98_copy.pm
Maintainer: justme1968
Schreibweise FHEM korrigiert

98_deletefile.pm
Maintainer: betateilchen(?) ; fehlt in https://fhem.de/MAINTAINER.txt
Kurzbeschreibung ergänzt

edit: erledigt, daher Patch entfernt
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 09 März 2018, 21:28:36
Anhängend Patch-Vorschläge für Module des Maintainers sachag:

22_ALL3076.pm
23_ALL4027.pm
23_WEBIO.pm
23_WEBIO_12DIGITAL.pm
88_ALL4000T.pm
88_Itach_Relay.pm
88_LINDY_HDMI_SWITCH.pm
88_VantagePro2.pm
88_WEBCOUNT.pm

Kann sachag im Forum nicht finden und mich auch nicht erinnern, dass er hier noch einmal aktiv war.
Rudi, übernimmst Du direkt?

Die Module nutzen soweit ich sehe nicht die readings*-Funktionen, noch loglevel und greifen direkt auf hash zu.
Laut https://fhem.de/stats/statistics.html und Forenrecherche scheint es für die Module kaum Nutzer zu geben.

Bei den summaries habe ich mich hier auf die Angabe des jeweils angesteuerten Gerätes beschränkt. Es fehlt "Anbindung von", "Steuerung von", "Modul für" in allen summaries, was ansonsten bei den vorhandenen Descriptions benutzt wird. Finde ich irgendwie überflüssig. Lasse mich aber auch vom Gegenteil überzeugen. Also bitte Kommentare dazu!
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: betateilchen am 09 März 2018, 21:55:41
Zitat von: krikan am 09 März 2018, 18:14:03
98_deletefile.pm
Maintainer: betateilchen(?) ; fehlt in https://fhem.de/MAINTAINER.txt

Das Modul ist obsolete, weil es das Ganze inzwischen als Funktion in fhem.pl gibt.
Deshalb hab ich das Modul nach contrib/deprecated verschoben.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: betateilchen am 09 März 2018, 21:56:36
Zitat von: krikan am 09 März 2018, 21:28:36
Kann sachag im Forum nicht finden und mich auch nicht erinnern, dass er hier noch einmal aktiv war.
Rudi, übernimmst Du direkt?

Die Module nutzen soweit ich sehe nicht die readings*-Funktionen, noch loglevel und greifen direkt auf hash zu.
Laut https://fhem.de/stats/statistics.html und Forenrecherche scheint es für die Module kaum Nutzer zu geben.

Sollte man die Module dann nicht besser nach ./contrib verschieben, wenn sich eh keiner mehr darum kümmert?
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 10 März 2018, 12:11:19
Zitat von: betateilchen am 09 März 2018, 21:56:36
Sollte man die Module dann nicht besser nach ./contrib verschieben, wenn sich eh keiner mehr darum kümmert?
Aus meiner Sicht schon, wenn sich niemand als Maintainer meldet, da ich Bedeutung für äußerst gering halte. Entscheidung und ggfs. Ausführung aber nicht durch mich. Rudi?
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 10 März 2018, 12:20:33
Anhängend Patch-Vorschlag für das Modul 98_WOL.pm des leider verstorbenen Dietmar63.

Fände es gut, wenn sich für das Modul von Dietmar ein neuer Maintainer finden/melden würde.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 10 März 2018, 16:28:53
Anhängend Patch-Vorschläge für Module des Maintainers (Boris) neubert:

00_CM11.pm
00_HXB.pm
09_BS.pm
09_USF1000.pm
10_HXBDevice.pm
20_X10.pm
80_M232.pm
81_M232Counter.pm
82_M232Voltage.pm

edit: erledigt, daher Patch entfernt
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: Dr. Boris Neubert am 10 März 2018, 16:40:36
Zitat von: krikan am 10 März 2018, 16:28:53
Anhängend Patch-Vorschläge für Module des Maintainers (Boris) neubert:

Danke! Mit kleinen Änderungen übernommen und eingecheckt.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 11 März 2018, 08:26:45
Anhängend Patch-Vorschlag für das Modul 10_EIB.pm von andi291.

10_EIB.pm ist "deprecated". Nachfolgemodul ist 10_KNX.pm.


edit: erledigt, daher Patch entfernt
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 11 März 2018, 13:08:28
Patch-Vorschlag Maintainer herrmannj:

32_TechemWZ.pm

In MAINTAINER.txt ist noch ein Modul FHEM/32_TechemSD.pm mit Maintainer hermannj enthalten, das ich nicht finde.  ???
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 11 März 2018, 15:09:23
Patch-Vorschläge Maintainer wherzig:

40_RFXCOM.pm
42_RFXMETER.pm
43_RFXX10REC.pm
45_TRX.pm
46_TRX_ELSE.pm
46_TRX_LIGHT.pm
46_TRX_SECURITY.pm
46_TRX_WEATHER.pm

70_USBWX.pm

edit: gestrichene Module haben neuen Maintainer (KernSani) und Summary wurde eingecheckt. Patch entsprechend angepasst/gekürzt.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: yoda_gh am 14 März 2018, 21:29:33
Danke für den Tritt, ich habe es proaktiv in meinem Modul 52_I2C_K30 erledigt.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 17 März 2018, 13:14:14
@yoda_gh: Danke!

Eigentlich hatte ich gehofft, dass noch mehr Maintainer eigenständig aktiv werden.  :)
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 17 März 2018, 13:15:58
Patch-Vorschläge Maintainer UliM:

10_Itach_IR.pm
88_Itach_IRDevice.pm
95_remotecontrol.pm
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 17 März 2018, 20:41:13
Patch-Vorschlag Maintainer heikoranft:

89_HEATRONIC.pm
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: krikan am 17 März 2018, 20:52:15
Patch-Vorschlag Maintainer Cooltux:

74_HOMBOT.pm
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: rudolfkoenig am 20 März 2018, 22:36:36
Damit die sinvolle Arbeit von krikan nicht verlorengeht: ich werde die Aenderungen bei den nicht angefassten Modulen in den naechsten Tagen selbst durchfuehren, falls keine Meldung vom betroffenen Autor inzwischen eintrifft.
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: CoolTux am 21 März 2018, 06:29:53
Guten Morgen Rudi

Vielen Dank für die Erinnerung, schämender Weise muss ich gestehen daß ich es seit Sonntag wieder vergessen habe. Setze es heute um.


Grüße
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: CoolTux am 21 März 2018, 09:54:34
Ahhhgrrrr

Rudi Rudi HILFE

Ich habe gerade das Hombot Modul aktualisiert mit der summary und habe beim commiten nicht aufgepasst nur mein Modul und die CHANGE mit an zu geben. Nun ist ausversehen noch meine geänderte 10_EQ3BT.pm mit gesendet worden.

Zitat
Sende              CHANGED
Sende              FHEM/10_EQ3BT.pm
Sende              FHEM/74_HOMBOT.pm

Kannst Du das bitte richten. Tut mir leid!



Grüße
Titel: Antw:Ergänzung fehlender "short description"/"Kurzbeschreibung" in commandref
Beitrag von: yoda_gh am 22 März 2018, 00:00:53
Hallo!

Zitat von: CoolTux am 21 März 2018, 09:54:34
Ahhhgrrrr

Rudi Rudi HILFE

Ich habe gerade das Hombot Modul aktualisiert mit der summary und habe beim commiten nicht aufgepasst nur mein Modul und die CHANGE mit an zu geben. Nun ist ausversehen noch meine geänderte 10_EQ3BT.pm mit gesendet worden.

Kannst Du das bitte richten. Tut mir leid!


Das solltest Du selbst können. "svn merge -r 16458:16457  FHEM/10_EQ3BT.pm" sollte die Änderungen lokal rückgängig machen. Wenn es passt, dann mit passendem Kommentar commiten...