Fehler in der deutschen Hilfe bitte hier melden (Hilfedatei 3.3.14.5 2019.08.02)

  • Hi,

    falls ihr beim benutzen der deutschen Hilfe Rechtschreibfehler, Formatfehler und inhaltliche Fehler findet, wäre es nett dass ihr diesen dann auch hier meldet.

    Dann können wir diese korrigieren.

    Bitte nur Fehler der Hilfedatei 3.3.14.5 2019.08.02 melden

  • Hallo,

    ich habe wieder einen Fehler gefunden.

    Es handelt sich um die Funktion

    Funktion _GUIImageList_AddIcon

    Da steht bei Parameter:

    $sFilePath Pfad zu dem Icon, welches das Icon enthält

    Das müsste wohl:

    $sFilePath Pfad zu der Datei, welches das Icon enthält

    heißen.

    Aber auch die englische Version des Satzes, ist wohl nicht so ganz richtig.

    Da steht nämlich:

    $sFilePath Path to the icon that contains the image


    MfG

    BigRox

  • Hallo.

    RunAsWait - Im Beispiel ist eine Zeile verdoppelt.

    Funktion RunAsWait

    Code
    ...
            ; Zeigt den Rückgabewert des Editorprozesses an.
            MsgBox($MB_SYSTEMMODAL, "", "Der Rückgabecode des Editors lautete: " & $iReturn)
            MsgBox($MB_SYSTEMMODAL, "", "Der Rückgabecode des Editors lautete: " & $iReturn)
        EndIf
    EndFunc   ;==>Example

    Tweaky: Danke für deine gute Arbeit!

    Wenn jemand sagt: "Das geht nicht!" Denke daran: Das sind seine Grenzen, nicht deine.

  • Hier noch nicht: RunAsWait 8o

    Es geht um die Hilfedatei 3.3.14.5 2019.08.02

    Tweaky sammelt die Fehler erst mal für die kommende Version - sie werden nicht umgehend in der akt. Onlinehilfe gefixt (meine ich zumindest).

    Gruß Musashi

    86598-musashi-c64-png

    "Am Anfang wurde das Universum erschaffen. Das machte viele Leute sehr wütend und wurde allenthalben als Schritt in die falsche Richtung angesehen."

  • So wie Musashi es schreibt ist es korrekt.

    Ich korrigiere die Fehler lokal bei mir.

    Irgendwann mal (kein fester Rhythmus) erzeuge ich dann wieder eine Online und Offline Hilfe.

  • FileFindFirstFile, FileFindNextFile.

    Im Beispiel sind ein paar Fehler in den Kommentaren.

    Derzeit: ; Weist eine lokale Variable dem Handle von allen DSateien in dem aktuellen Verzeichnis zu.

    Vorschlag: ; Weist einer lokalen Variable ein Such-Handle für alle Dateien im aktuellen Verzeichnis zu.

    Derzeit: ;Weist eine lokale Variable dem leeren String zu welcher die Namen der gefundenen Dateien enthält. <== Hää? =O

    Vorschlag: ;Weist einer lokalen Variable einen leeren String zu, die die Namen der gefundenen Dateien aufnimmt.

    Und zum Schluss: ; Zeigt den Dateienamen.

    Gruß.

    Wenn jemand sagt: "Das geht nicht!" Denke daran: Das sind seine Grenzen, nicht deine.

  • Derzeit: ; Weist eine lokale Variable dem Handle von allen DSateien in dem aktuellen Verzeichnis zu.

    Vorschlag: ; Weist einer lokalen Variable ein Such-Handle für alle Dateien im aktuellen Verzeichnis zu.


    Derzeit: ;Weist eine lokale Variable dem leeren String zu welcher die Namen der gefundenen Dateien enthält. <== Hää? =O


    Vorschlag: ;Weist einer lokalen Variable einen leeren String zu, die die Namen der gefundenen Dateien aufnimmt.

    Ich hielte es für besser, die entsprechenden Kommentare zu entfernen, statt sie zu korrigieren. Unnötig.

    Grüße autoiter

  • Vielleicht bist du zu sehr Profi und siehst das nicht mehr, aber für Anfänger sind Kommentare oft wichtig. Ich selbst bin zwar kein Anfänger, aber nach 10 Jahren Pause gehts mir irgendwie so ähnlich.

    Wenn jemand sagt: "Das geht nicht!" Denke daran: Das sind seine Grenzen, nicht deine.

    2 Mal editiert, zuletzt von Professor Bernd (4. September 2019 um 15:07)

  • Ich hielte es für besser, die entsprechenden Kommentare zu entfernen, statt sie zu korrigieren. Unnötig.

    Berücksichtigt man an welche User sich die Hilfe in erster Linie richtet, so halte ich das nicht für unnötig. Sicher gibt es Kommentare z.B. zu Funktionsaufrufen, die selbsterklärend sind, wie in :

    Auszug aus dem Hilfebeispiel #2 zu FileOpen :

    Trotzdem ist ein so ausführlich dokumentierter Ablauf für viele User sicher hilfreich !

    Natürlich hat die Bereinigung von irreführenden oder sogar falschen Aussagen in der Hilfe eine höhere Priorität, als 'reine Tippfehler' zu beseitigen wie :_FTP_Close / Funktion _FTP_Open : Beispiel mit externem Progressfenster zur Demostration der ...

    oder :

    FileFindFirstFile / FileFindNexttFile :
    Wenn die Suche mit den FileFind...-Funktionen beendet wurde, muss FileClose() aufrufen werden, ...
    Wenn die Suche mit den FileFind...-Funktionen beendet wurde, muss FileClose() aufgerufen werden, ...

    usw.

    Daher würde ich aus organisatorischen Gründen und auch um es Tweaky leichter zu machen :

    • Inhaltliche Fehler sowie sinnvolle Ergänzungen als Einzelbeitrag melden.
    • Rechtschreibfehler sammeln und als 'Paket' melden - sonst platzt der Thread auseinander :P

    Gruß Musashi

    86598-musashi-c64-png

    "Am Anfang wurde das Universum erschaffen. Das machte viele Leute sehr wütend und wurde allenthalben als Schritt in die falsche Richtung angesehen."

  • Hallo Musashi

    selbst, wenn man das klarer formuliert ist es schlecht. Wenn man in der Hilfe zu FileFindFirstFile verstehen muss, dass Local $sFileName = "" eine lokale Deklaration einer Variable ist, die hier (deutlicher als in AutoIt notwendig) mit einem leeren String initialisiert wird, ist das doch mindestens suboptimal.. Wenn man dann auch noch sieht, dass in der Folgezeile zwei unterschiedliche Variablen deklariert werden, auf die die Beschreibung nicht insgesamt passt, denke ich, man sollte das einfach weglassen..
    Das gilt genauso für die andere genannte Funktion..

    Code
    ;Weist eine lokale Variable dem leeren String zu welcher die Namen der gefundenen Dateien enthält.
        Local $sFileName = "", $iResult = 0

    Grüße autoiter

  • Hi autoiter

    Das gilt genauso für die andere genannte Funktion..

    Vorab : Die besagten Bereiche inkl. Tippfehler sind in beiden Funktionen identisch (C&P). Insgesamt ist die Übersetzung etwas lieblos, wobei das Original auch nicht sonderlich besser ist).

    Der von Dir angesprochene Teil, also :

    Code
        ;Weist eine lokale Variable dem leeren String zu welcher die Namen der gefundenen Dateien enthält.
        Local $sFileName = "", $iResult = 0

    ist wirklich ziemlicher Schwachsinn.

    Ich war wohl zu sehr darauf fixiert, dass Kommentare, die eigentlich etwas Selbstverständliches beschreiben, für Einsteiger trotzdem hilfreich sein können:whistling:.

    Wenn man dann auch noch sieht, dass in der Folgezeile zwei unterschiedliche Variablen deklariert werden, auf die die Beschreibung nicht insgesamt passt, denke ich, man sollte das einfach weglassen..

    Hier wahrscheinlich schon - alternativ ggf. noch :/:

    Code
        ; $sFileName wird der jeweils durch FileFindNextFile() gefundene Dateiname zugewiesen (sofern vorhanden)
        Local $sFileName = "", $iResult = 0

    Professor Bernd :

    Deine Reaktion, also Oder gleich die ganze Hilfe entfernen, statt sie zu korrigieren !?, darf aber auch gerne überdacht werden :P.

    Gruß Musashi

    86598-musashi-c64-png

    "Am Anfang wurde das Universum erschaffen. Das machte viele Leute sehr wütend und wurde allenthalben als Schritt in die falsche Richtung angesehen."

  • Hallo,

    hier kommt der nächste Fehler.

    Diesmal handelt es sich um die Funktion:

    StringSplit

    Das steht bei Bemerkungen:

    Falls das Trennzeichen mehrere Zeicben enthält ist das Verhalten der Funktion abhängig von den Flag-Eionstellungen.

    Naja, in den Satz haben sich wohl ein Paar falsche Zeichen reingemogelt:D.

    MfG.

    BigRox

  • Funktion StringSplit :

    Falls das Trennzeichen mehrere Zeicben enthält ist das Verhalten der Funktion abhängig von den Flag-Eionstellungen.

    Naja, in den Satz haben sich wohl ein Paar falsche Zeichen reingemogelt :D .

    Nicht nur dort :

    1.

    Falls der flag parameter auf $STR_NOCOUNT (2) gesetzt, wird die Anzahl nicht in dem ersten Element enthalten sein.

    Falls der flag parameter auf $STR_NOCOUNT (2) gesetzt ist, wird die Anzahl nicht in dem ersten Element enthalten sein.

    (-> ist oder wurde)

    2.

    Falls das Flag ungleich $STR_NOCOUNT ist, so wird $aArray[0] auf 1 gesetzt und der komplette Strijng wird in $aArray[1] zurückgegeben.

    3.

    Wird als Tennzeichen ein Leerstring "" angegeben, so wird jedes Zeichen des Strings im Array als Element zurückgegeben.

    4. (von BigRox bereits genannt) :

    Falls das Trennzeichen mehrere Zeicben enthält ist das Verhalten der Funktion abhängig von den Flag-Eionstellungen.

    5.

    Falls $STR_CHRSPLIT eingestellt st, so wird der String bei jedem einzelnen Zeichen des Trennzeichen-Strings getrennt.

    6.

    Falls $STR_ENTIRESPLIT eingestellt st, so wird der String nur getrennt wenn der komplette Trennzeichen-String vorkommt.

    Natürlich ist eine gute Rechtschreibung wichtig ! Wir sind aber alle keine Super-Germanisten, d.h. jeder macht Fehler (der eine mehr - der andere weniger).

    Würde jeder Tippfehler einzeln gepostet werden, dann führt das ggf. zu hunderten von Beiträgen ! Daher noch mal mein Vorschlag :

    -> inhaltliche Fehler und Ergänzungsvorschläge als Einzelbeitrag melden

    -> Tippfehler sammeln und als Paketbeitrag melden

    Tweaky : Wie siehst Du das ?

    Gruß Musashi

    86598-musashi-c64-png

    "Am Anfang wurde das Universum erschaffen. Das machte viele Leute sehr wütend und wurde allenthalben als Schritt in die falsche Richtung angesehen."

  • Danke für das melden der Fehler.

    Habe alle korrigiert.

    Wie ihr das meldet ist mir egal. Hauptsache es wird gemeldet ...;)