killercup / killercup/a-range

Add doc tests to Panic documentation

Offen
#11 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
good first issue Hacktoberfest help wanted in progress
Vorherrschende Sprache
Rust
Sterne
15
Forks
7
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

We recently added these docs:

https://github.com/killercup/a-range/blob/ce391ed856e5fb52e9445496ccec046b91359ed5/src/lib.rs#L54-L58

This behavior is tested in this unit test:

https://github.com/killercup/a-range/blob/ce391ed856e5fb52e9445496ccec046b91359ed5/src/lib.rs#L393-L397

It is also possible for this to become a [doc test](https://doc.rust-lang.org/1.29.2/rustdoc/documentation-tests.html#attributes) (as I've just found out), which would make this more visible.

- [ ] Turn `fail_up_to_invalid_range` and `fail_down_to_invalid_range` tests into doc tests

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie in src/lib.rs bei der Panic-Dokumentation um die Zeilen 54–58 und den Unit-Tests um die Zeilen 393–397. Überprüfen Sie die Tests fail_up_to_invalid_range und fail_down_to_invalid_range und führen Sie anschließend die Rust-Dokumentationstests aus, um zu verifizieren, dass beide Fälle als Dokumentationstests abgedeckt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust
Bereich
documentation, testing
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.