Skip to content

449#454

Merged
RAprogramm merged 2 commits into
mainfrom
449
Jul 5, 2026
Merged

449#454
RAprogramm merged 2 commits into
mainfrom
449

Conversation

@RAprogramm

Copy link
Copy Markdown
Owner

Closes #449

Documentation accuracy pass driven by three independent audits (README template, ru/ko READMEs, rustdoc prose). Docs now match actual behavior; no code changes.

README.template.md (README.md regenerated)

  • Problem JSON snippet: nonexistent with_retry_after_duration on AppError → with_retry_after_secs(30)
  • Telemetry section: removed the panicking request_ref through a converted AppError; documented that generated From conversions carry only kind/code (+optional message) and forward no sources/providers; added nightly note for error_generic_member_access
  • DisplayMode section rewritten as environment-detection API (Display does not consult the mode)
  • telegram-webapp-sdkinit-data (the feature that actually exists); turnkey highlight without nonexistent tracing instrumentation; std on by default; examples claim matched to reality; colored/benches wording fixed

rustdoc (22 files, doc comments only)

  • downcast_mut honestly documented as a stub; is/downcast_ref clarified to inspect the source
  • redis doc example now asserts the real mapping (IO → DependencyUnavailable) and compiles as a guarded doctest
  • five convert modules no longer claim 'error text preserved in message' (it goes to metadata + source chain)
  • actix: removed nonexistent empty-body mode, fixed field inventory (code, grpc), fixed broken intra-doc link
  • lib.rs front page: MSRV 1.96, feature list corrected and completed (init-data, sqlx-core, sqlx-migrate, colored, tracing, metrics, backtrace)
  • broken apostrophe fences fixed; never-compiling cfg(test) doc examples replaced with prose; grpc.name/value field names; reqwest impl-doc mapping; io::Error std-gating; AppCode underscore rules; redaction wording on axum/actix impls; .context() reclassification note; tokio timeout wording

README.ru.md / README.ko.md (full resync with English)

  • versions 0.24.19 → 0.28.0, MSRV 1.96, license MIT-only badges/footers, REUSE badge, missing Examples section + TOC, install snippet with init-data/colored, all fresh accuracy fixes propagated; code blocks byte-identical to English

Verification: full workspace test suite, doctests (172 passing), clippy zero warnings, nightly rustfmt clean, readme_sync 36/36.

@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@RAprogramm RAprogramm merged commit fed3f96 into main Jul 5, 2026
29 checks passed
@RAprogramm RAprogramm deleted the 449 branch July 5, 2026 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs accuracy: fix fabricated and stale claims across rustdoc and READMEs

1 participant