Repository navigation
Polished the README and docs, converged source comments and corrected stale claims. - #1057
Merged
Merged
Conversation
…ments that contradicted the code.
…o 'docs/usage.md' and fixed documentation drift.
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
📒 Files selected for processing: 1
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
WalkthroughThe test workflow now targets only ChangesDocumentation and CI
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~12 minutes Change: Other Suggested labels: Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title clearly summarizes the primary changes: README and documentation updates, source-comment alignment, and correction of stale claims. |
| Docstring Coverage | |
Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 24 functions across 50 files. (27 skipped:… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
A rabbit checks the branch list twice,
Then hops through guides made clear and concise.
New notes explain the hooks and cleanup,
While old comments get a tidier loop.
The burrow rests; the docs are nice!
Comment @coderabbitai help to get the list of available commands.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1057 +/- ##
=======================================
Coverage 96.46% 96.46%
=======================================
Files 179 179
Lines 8995 8995
=======================================
Hits 8677 8677
Misses 318 318 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
AlexSkrypnyk
added
the
Needs review
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
README.mdnow runs in the order a new user needs it: installation and Quick start come before the generated step index,JavaScript browser driverssits under Installation,Exceptionssits under Public API and versioning, and the hook-skipping, entity cleanup and same-title sections moved intodocs/usage.md. Every README section heading, feature bullet and docs index entry carries an emoji, and so does each hand-written page title, sodocs.phpnow replaces the README index under## 📋 Available steps.The docs and comments had drifted from the code in places a reader would act on.
CONTRIBUTING.mdsent renamed CI legs to required checks on the deleted4.xbranch, and the CI workflow still triggered on it.WatchdogTraitdocumented@watchdog:{type}as limiting the tracked types when it adds tophp,EckTraitclaimed to create ECK types and bundles, andMetatagTraitdescribed resolving against the whole Mink base URL rather than its origin.src/Backend/Drupal/Core/Field/README.mdshowed(array) $stub, aBackend\Core11namespace and an automatic classifier lookup thatCore::createFieldClassifier()doesn't do. 33 comments insrc/,tests/,scripts/anddocs.phpmade claims like these, and each was checked against the code before it changed.After merge,
STEPS.md,HELPERS.mdand the README step index carry the corrected trait descriptions, and about 4,800 source comments read as plain technical statements: 75 rewritten and 2 deleted, mostly long sentences split and history words dropped. No step text, method signature, failure message or test assertion changes: outside thedocs.phpmarker string, every PHP change is a comment, and a token-level comparison againstmainconfirms it.MIGRATION.mdkeeps its tables and headings, anddocs/architecture/is unchanged because nothing structural moved.Before / After
Changes
README and docs
README.md: reordered as above, added emoji to every section heading, feature bullet and docs index entry, wrapped the 2 long commands, and fixed 3 claims. Trait methods are prefixed with the trait's name, not "properly namespaced". "Ensure that yourbehat.php" no longer links to this repository's own test harness configuration. The logo alt text lost a doubled word.docs/usage.md: took the 3 moved sections as written.Skipping hooksjoinedSwitch a trait off, which covered theenabledoption but only named the skip tag, andEntities a scenario createsalso points atBEHAT_STEPS_DISABLE_CLEANUP.docs.php: the README start marker is now## 📋 Available steps.CONTRIBUTING.md: required checks live on themainruleset, the docs validation list includes the check that every documented step matches exactly 1 definition, and 2 grammar slips in the local setup steps are fixed.src/Backend/Drupal/Core/Field/README.md: the stub API, theBackend\Drupal\Core{N}lookup inDrupalBackend::setCoreFromVersion(), thecreateFieldClassifier()override, bundle scoping in the pipeline walk-through, and the UTC reading ofdate_recurvalues now match the code. Its prose is 1 line per paragraph and its examples fit 80 columns.docs/configuration.md,docs/http-clients.md,docs/scenario-styles.md,SECURITY.md: page title emoji, and number words as digits where they count something.MIGRATION.md,CLAUDE.md: 2 PHP examples and 3 shell commands wrapped to 80 columns. The long lines left inMIGRATION.mdare literal error output and Gherkin steps, which can't wrap..github/workflows/test.yml: removed the deleted4.xbranch from the push and pull request triggers.Source comments
STEPS.md,HELPERS.mdor the README index:WatchdogTrait(@watchdog:{type}adds tophp),EckTrait(works on existing ECK types and bundles),MetatagTrait(resolves against the base URL's origin),BigPipeTrait(thebig_pipe_nojscookie goes only to a browser driver without JavaScript) andTaxonomyTrait(creates terms in an existing vocabulary).src/claims:DrupalContextandWebContextmixed up registering and extending a context,BlackboxBackendInterfaceexcluded only 1 capability namespace,RolesAliascalled its user capability a backend,DateRecurHandlersaid date_recur readsvaluein the record's own timezone (it reads it as UTC), andParametersTrait,MinkAwareTrait,EntityLifecycleTrait,FieldTraitandBackendInterfaceeach stated 1 detail more strongly or more narrowly than the code.scripts/provision.php,docs.phpandtests/behat/bootstrap/FeatureContextTrait.php: 6 docblocks described their constant, function or hook inaccurately.ClassNamingTest,TraitMethodNamingTest,AuthenticatorTest,DrupalBackendDelegationTestand 6 kernel tests claimed coverage they don't have, or described Drupal behavior the wrong way round, such as entity_test's default bundle.Validation
README.md,LICENSE,SECURITY.mdandCONTRIBUTING.mdall exist with the expected casing.Follow-up
src/Backend, the cookie failure messages, and the timezone of adate_recurvalue.warntag alias isn't documented,discoverTraitFiles()also yieldsAssertionException.php(harmless while it declares no methods), the post-stop assertion intestMailLifecycleRoundTrippasses whatevermailStopCollecting()does, and 2deleteEntity()paths have no kernel test.Checks
ahoy lint: phpcs, PHPStan, Rector, gherkinlint, the layer lint and the trait lint all pass.ahoy lint-docs: the generated documentation is up to date.ahoy test-unit: 9,794 tests and 12,336 assertions pass.Summary
docs/usage.md.4.xbranch from CI triggers.CONTRIBUTING.md.Validation
The author reports that
ahoy lint,ahoy lint-docs, andahoy test-unitpassed. The reported unit test run covered 9,794 tests and 12,336 assertions. These results were not independently verified.Review findings
Severity counts are unavailable because current review findings were not supplied. No Critical step-definition violations are established by the available evidence.