docs: generalize target audience beyond receiver development - #11
Merged
Conversation
The description, README, and project plan all framed rinexfetch as a tool specifically for a "GNSS receiver development lab", but nothing about the tool is actually receiver-development-specific: it fetches and combines RINEX files for anyone who needs them, whether that's post-processing, analysis, testing, or other GNSS work. Generalize the crate description, the Debian package's extended description, the README's opening paragraph, and the project plan's Purpose section and incidental "GNSS lab" wording accordingly. Signed-off-by: Oleksandr Suvorov <cryosay@gmail.com>
The Reliability section stated that retry/backoff on transient network failures and structured logging were already implemented. Neither exists in the current implementation. Replace both claims with an accurate description of current behavior (specific, distinct errors per failure class) and note that retry/backoff and structured logging are not yet implemented, consistent with CHANGELOG.md's documented known limitations. Signed-off-by: Oleksandr Suvorov <cryosay@gmail.com>
MrCry0
force-pushed
the
docs/generalize-purpose
branch
from
August 14, 2026 13:55
f82afe7 to
520773e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
a tool "for a GNSS receiver development lab", but nothing about it
is actually receiver-development-specific. Reworded the crate
description, the Debian package's extended description, the
README's opening paragraph, and the project plan's Purpose section
and incidental "GNSS lab" wording to describe it as a tool for
anyone who needs combined RINEX files (post-processing, analysis,
testing, or other GNSS work).
Reliability section claimed "retries with backoff on transient
network failures" and "structured logging ... for troubleshooting"
as if already shipped. Neither is implemented (confirmed by
grepping src/ for retry/backoff logic and any logging crate; found
none). This predates this PR and matches Phase 6 in the project
plan, already listed as a known gap in CHANGELOG.md. Replaced with
an accurate description of what's shipped (specific, distinct
errors per failure class) and an explicit note on what's not yet
implemented.
describe actual GNSS hardware (a station's receiver submission, and
receiver/firmware quirks), not the tool's target audience.
Test plan
cargo fmt --check,cargo clippy --all-targets -- -D warnings,cargo build --all-targets,cargo testall pass locally