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 invalid docs #666

Merged
merged 1 commit into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions docs/book.bak/src/de/guide/cmds/invalid.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/book/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
:root {
--content-max-width: 90%;
--sidebar-width: 230px;
}


body {
font-family: arial, sans-serif;
}
Expand Down
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
- [completions](./referenz/kommandos/completions.md)
- [count](./referenz/kommandos/count.md)
- [frequency](./referenz/kommandos/frequency.md)
- [invalid](./referenz/kommandos/invalid.md)
1 change: 1 addition & 0 deletions docs/book/src/referenz/kommandos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
* [count](./count.md) — Zählen von Datensätzen, Felder und Unterfeldern
* [frequency](./frequency.md) — Ermitteln einer Häufigkeitsverteilung
über ein oder mehrere Unterfelder
* [invalid](./invalid.md) — Findet ungültige Zeilen in der Eingabe
29 changes: 29 additions & 0 deletions docs/book/src/referenz/kommandos/invalid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# invalid

![stability-badge](https://img.shields.io/badge/stability-stable-green?style=flat-square)

Das `invalid`-Kommando findet Zeilen in der Eingabe, die nicht als
normalisiertes PICA+ dekodiert werden konnten und somit ungültig sind.

## Beschreibung

Bei der Verarbeitung von PICA-Daten kann es vorkommen, dass Zeilen in
der Eingabe nicht dekodiert werden können. Diese ungültigen Zeilen
lassen sich bei vielen Kommandos mit der Option `--skip-invalid` (bzw.
`-s`) überspringen, wobei die Anzahl der übersprungenen Zeilen nicht
angezeigt wird. Es kann aber empfehlenswert oder notwendig sein, die
Anzahl invalider Datensätze zu kontrollieren und einer Prüfung zu
unterziehen, um diese ggf. zu korrigieren.

Der folgende Befehl findet alle ungültigen Datensätze aus der Datei
`DUMP.dat.gz` und schreibt diese Zeile in die Datei `invalid.dat`:

```console
$ pica invalid DUMP.dat.gz -o invalid.dat
```

## Optionen

* `-o`, `--output` — Angabe, in welche Datei die Ausgabe geschrieben
werden soll. Standardmäßig wird die Ausgabe in die Standardausgabe
`stdout` geschrieben.
3 changes: 2 additions & 1 deletion pica-toolkit/tests/snapshot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,6 @@ fn cli_tests() {
#[test]
fn doc_tests() {
trycmd::TestCases::new()
.case("../docs/book/src/referenz/kommandos/frequency.md");
.case("../docs/book/src/referenz/kommandos/frequency.md")
.case("../docs/book/src/referenz/kommandos/invalid.md");
}
Loading