docs: correct stale facts in README for 0.4.1 - #15
Merged
Conversation
The README is the pub.dev landing page, and several of its claims had drifted from the code: - The install snippet advertised `appstream_dart: ^0.2.2`, three releases behind. That is the line people copy. - Status and test count were equally old: 194 tests now pass (149 C++ and 45 Dart), not 185. - The project tree was rooted at `appstream/`, the name before the 0.2.1 rename, listed `dart_api_dl.c` where the file is now `.cpp`, described bindings.dart as doing "library loading" after 0.4.1 moved that to the native-asset table, and omitted scripts/. - Prerequisites claimed Clang 17+, but expected_polyfill.h notes that std::expected needs Clang 19+ and the polyfill was added for Clang 18, so 18 is the floor that is actually supported. The Quick start section already said 18+, so the two sections disagreed. - The CI description said "8+ configurations"; there are 9 jobs, one of which is a Debug/Release x asan/ubsan matrix. Every figure was checked against the tree rather than estimated: ctest reports 149, dart test reports 45, and the workflow parses to 9 jobs. Verified: clang-tidy clean, clang-format run last via scripts/format.sh, 149/149 C++ and 45/45 Dart tests, dart analyze --fatal-infos clean.
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.
The README is the pub.dev landing page, and several claims had drifted from the code. Every figure below was checked against the tree, not estimated.
appstream_dart: ^0.2.2^0.4.1Production-Ready (v0.2.2)(v0.4.1)185/185 (140 C++ + 45 Dart)194/194 (149 C++ + 45 Dart)appstream/(pre-0.2.1 rename)appstream_dart/dart_api_dl.cdart_api_dl.cppbindings.dart@Nativebindings, native-asset resolvedClang 17+Clang 18+Also adds the missing
scripts/entry to the tree.The install snippet is the one that actually bites — it's the line people copy, and it pointed three releases back.
On the compiler floor: the README contradicted itself, saying Clang 18+ in Quick start and Clang 17+ in Prerequisites.
include/expected_polyfill.hnotesstd::expectedneeds Clang 19+, and CHANGELOG 0.2.1 added the polyfill specifically for Clang 18, so 18 is the version actually supported and tested. 17 appears to have been aspirational.Sources:
ctest -Nreports 149,dart testreports 45, and parsingci.ymlyields 9 jobs.Verification
clang-tidy clean, clang-format run last via
scripts/format.sh, 149/149 C++ and 45/45 Dart tests,dart analyze --fatal-infosclean,dart pub publish --dry-run0 warnings.