Repository navigation
docs(transport-packages): fact-check against MODX 3.x, editorial pass, en/ru sync - #653
Merged
Merged
Conversation
…, en/ru sync Audit the three Transport Package pages against revolution 3.x. Facts corrected: - drop the removed 2.0.0-beta defines paragraph; UNIQUE_KEY is singular - build script example uses MODX\Revolution\Transport\modPackageBuilder instead of a global modPackageBuilder that no longer resolves - version constraints: bare `!` replaced with `!=`, operator meanings reordered, and the untrimmed space after a comma documented - vehicle_package / package are empty in MODX 3 packages - resolver naming scheme, including the doubled `.resolver` suffix - preserve_keys applies to inserts only - drop the RC-2 and trailing-slash claims that code cannot confirm Added from the code: - Dependencies tab, abort_install_on_unsatisfied_dependency, provider download and the resolveDependency() limitation (#17065) - OnPackageInstall / OnPackageUninstall / OnPackageRemove - xPDOScriptVehicle, silent_fail, ARCHIVE_WITH options - builder API reference, modTransportVehicle, validator caveats Editorial pass and en/ru sync.
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.
Audit of
en/extending-modx/transport-packages/*againstmodxcms/revolution3.x, plus an editorial pass and anen/rusync.Report: 24 findings — 1 PHANTOM, 8 STALE, 1 ORPHAN, 11 UNDOCUMENTED, 3 UNVERIFIABLE. 23 closed; one historical claim (
requireslanded in 2.4) could not be verified locally and was left as is.Facts corrected
XPDO_TRANSPORT_*defines; the constant isxPDOTransport::UNIQUE_KEY, singularmodPackageBuilder(no such class in MODX 3) — it now usesMODX\Revolution\Transport\modPackageBuilder!replaced with!=, operator meanings reordered, and the fact that the parser does not trim a space after a comma is documentedvehicle_packageand the vehiclepackagekey are empty ('') in MODX 3 packages; the legacy values only appear for classes without a namespace{signature}.{source name without .php}.resolver, including the doubled.resolversuffix that follows from a*.resolver.phpsourcepreserve_keysapplies to inserts only; an existing row keeps its key regardless ofUPDATE_OBJECTUNIQUE_KEY/ primary key "required" claim corrected, and a missing parenthesis in thefile_get_contents()example fixedAdded from the code
abort_install_on_unsatisfied_dependency, provider download, and theresolveDependency()limitation (#17065)OnPackageInstall,OnPackageUninstall,OnPackageRemovexPDOScriptVehicle, validatorsilent_fail,ARCHIVE_WITHoptionsmodTransportVehiclereturn type, and the validator caveats (uninstall, related objects)Editorial pass
Rewritten for clarity and shortened where the original repeated itself. Markdown markers for the missing illustrations were collected and removed from the pages; the media brief is tracked separately.
es/nldo not carry this section, so nothing to sync there.