Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise frequency docs #665

Merged
merged 5 commits into from
Jul 18, 2023
Merged

Revise frequency docs #665

merged 5 commits into from
Jul 18, 2023

Conversation

nwagner84
Copy link
Member

@nwagner84 nwagner84 commented Jul 17, 2023

@nwagner84 nwagner84 self-assigned this Jul 17, 2023
@nwagner84 nwagner84 added C-documentation Category: documentation C-frequency labels Jul 17, 2023
@nwagner84 nwagner84 added this to the v1.0.0 milestone Jul 17, 2023
Copy link

@mschumac mschumac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ein inhaltlicher Punkt: Z. 42 gibt die Implementierung von --threshold korrekt wieder. Mein persönlicher Geschmack ist jedoch, dass Schwellenwerte einschließend gelten. Bei --threshold 1 würde ich also erwarten, dass alles ab Häufigkeit 1 und nicht erst ab Häufigkeit 2 zählt.

Ansonsten Schreibweisen:

  • Z. 5 Kein Fehler, aber - und das ist mir beim count-Kommando durchgerutscht - schau bitte, dass du für "mithilfe" oder "mit Hilfe" konsequent eine Schreibweise im Buch durchziehst.
  • Z. 34 "Vergleichen" statt "Vergelichen"
  • Z. 36 "Festlegen" groß, da substantiviert
  • Z. 40 "Eingrenzung der Ausgabe auf die ersten n Treffer" Das klingt so, als würden die Datensätze nur bis zum Erreichen des insgesamt n-ten Unterfeldes durchgegangen. In der englischen Hilfe hast da dagegen verständlicher auf die n häufigsten Unterfeldwerte abgezielt.
  • Z. 73 Komma nach "ist es häufig sinnvoll", da "es", "damit" oder "daran" bei Infinitivsätzen ein Komma erfordern
  • Z. 94 "Durch Verwenden eines Pfad-Ausdrucks in {}-Notation," Das Komma ist zu viel. Im Englischen würde hier ein Komma stehen, im Deutschen gibt es dafür keinerlei Veranlassung.
  • Z. 114 "Soll die Ergebnismenge auf die ersten n Häufigkeiten eingeschränkt werden,": "auf die n häufigsten Unterfeldwerte" fände ich passender
  • Z. 116 Der Punkt am Ende des Satzes fehlt.
  • Z. 143 Auch nach "d.h." steht ein Komma, auch wenn das komisch aussieht, aber wenn danach ein ganzer Hauptsatz folgt, ist das erforderlich.
  • Z. 160 "TSV- Format" Leerzeichen zu viel

@nwagner84 nwagner84 requested a review from mschumac July 17, 2023 16:24
Copy link
Contributor

@san-uh san-uh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vielen Dank @mschumac Ich habe keine weiteren Ergänzungen. Eine Diskussion zu --threshold versus können wir gerne nochmal führen. In der Praxis bin ich auch schon über die aktuelle Auslegung von -t gestolpert.

@nwagner84 nwagner84 merged commit 50e1d35 into main Jul 18, 2023
25 checks passed
@nwagner84 nwagner84 deleted the revise-frequency-docs branch July 18, 2023 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-documentation Category: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants