Skip to content

Proofread comments and documentation#148

Merged
alexander-yevsyukov merged 9 commits into
masterfrom
proofread-etc
Jul 24, 2026
Merged

Proofread comments and documentation#148
alexander-yevsyukov merged 9 commits into
masterfrom
proofread-etc

Conversation

@alexander-yevsyukov

@alexander-yevsyukov alexander-yevsyukov commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

A full English-prose proofreading sweep across the project's KDoc, code comments, and Markdown, together with the routine version bump, config refresh, and dependency-report regeneration that accompany a branch in this repo.

Changes

Proofreading & prose cleanup

  • 208 catalog fixes across 86 files (Proofread comments and documentation) applying the shared english-style.md catalog: restrictive which → that (~85, reflecting the Flogger-derived core), missing articles, comma fixes (introductory clauses and comma splices), compound-modifier hyphenation, confusables (lookup → look up, as is it → as if it), API-summary verb forms, and spelling (fot → for, enqueing → enqueuing).
  • ~30 further typo fixes the catalog does not cover (Fix comment and doc typos outside the proofreading catalog, Remove stray "with" from forced-logging SEVERE message): wrong-word swaps (if → it, of → or, same → save), missing words (than, as), stray @see markup, and similar.
  • A follow-up commit (Wrap over-long KDoc line and add missing articles) resolves the two non-blocking Should-fixes the pre-PR reviewers found.
  • Removed two outdated .agents docs (Remove outdated .agents docs duplicated elsewhere): project-overview.md (superseded by docs/project.md) and java-kotlin-conversion.md (superseded by the shared java-to-kotlin skill). Neither was referenced elsewhere.

Mechanical / build

  • Bump version -> `2.0.0-SNAPSHOT.423` — snapshot +1, per the version gate.
  • Update `config` — refreshed the config submodule and redistributed build logic via ./config/pull (139 files).
  • Update dependency reports — regenerated docs/dependencies/{pom.xml,dependencies.md}.

Reviewer notes

  • All prose edits are comment/doc-only — no code, identifiers, string literals, or [link]/code-span tokens changed (verified by token-count parity). Compilation and Dokka are unaffected.
  • Copyright headers were intentionally left unchanged. The repo's update-copyright PostToolUse hook rewrites headers on every edit and drops the upstream The Flogger Authors Apache-2.0 attribution; headers were restored so this PR stays prose-only. A separate follow-up addresses the hook itself.
  • Per repo convention, the config-distributed files in the Update `config` commit (buildSrc, workflows, etc.) belong to the config repository's review, not this one.

Test / pre-PR gate

  • ./gradlew build dokkaGenerate → BUILD SUCCESSFUL (304 tasks; JDK 17), dependency reports regenerated, KDoc links resolve, no test failures.
  • Reviewers: kotlin-engineer APPROVE; spine-code-review and review-docs APPROVE WITH CHANGES (two trivial Should-fixes, both now resolved). Zero Must-fix. Version gate satisfied (.422 → .423).

🤖 Generated with Claude Code

alexander-yevsyukov and others added 8 commits July 23, 2026 18:03
@alexander-yevsyukov
Bump version -> 2.0.0-SNAPSHOT.423
d1c3921
@alexander-yevsyukov
Update config
d604af6
@alexander-yevsyukov
Update dependency reports
baf7fd4
@alexander-yevsyukov @claude
Proofread comments and documentation
fc42804 
Apply the English-style catalog across project-owned prose in KDoc,
code comments, and Markdown: restrictive "which" -> "that", missing
articles, comma fixes (introductory clauses and comma splices),
hyphenated compound modifiers, confusables, verb forms in API
summaries, and spelling. Edits touch prose only -- no code,
identifiers, string literals, link targets, or copyright headers.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@alexander-yevsyukov @claude
Remove stray "with" from forced-logging SEVERE message
e7405f9 
The word was orphaned during the Java->Kotlin conversion (7da45be): the upstream Flogger literal read "...with Flogger has been partially disabled", and dropping "Flogger" left "with" behind.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@alexander-yevsyukov @claude
Fix comment and doc typos outside the proofreading catalog
81ca194 
Correct wrong-word typos, missing words, garbled phrases, and stray markup in KDoc/comment prose, one test comment, and README that the catalog-driven proofread pass intentionally left alone (its "invent no rules" bias). Prose only: no code identifiers or string literals changed, and copyright headers were preserved.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@alexander-yevsyukov @claude
Remove outdated .agents docs duplicated elsewhere
e32e8e5 
Delete `.agents/java-kotlin-conversion.md` (superseded by the `java-to-kotlin` skill) and `.agents/project-overview.md` (its stack list duplicates `docs/project.md` and the shared guidelines). Both were unreferenced across the repo.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@alexander-yevsyukov @claude
Wrap over-long KDoc line and add missing articles
2cee319 
Resolves two non-blocking Should-fixes surfaced by the pre-PR review: a KDoc line in `SegmentTrie.kt` that a grammar fix pushed past the 100-char limit, and two missing articles in `AbstractLoggerSpec.kt`.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 23, 2026 19:46
Copilot AI reviewed Jul 23, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Performs a broad proofreading pass across KDoc/code comments/Markdown, while also applying the routine version bump and regenerating dependency/build-related artifacts as part of a config refresh for this repository.

Changes:

  • Proofread and normalize English prose across KDoc, code comments, and Markdown throughout the project.
  • Bump snapshot version to 2.0.0-SNAPSHOT.423 and regenerate dependency report outputs.
  • Refresh config-distributed build logic and related build tooling/reporting inputs.

Reviewed changes

Copilot reviewed 221 out of 230 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
version.gradle.kts Snapshot version bump to 2.0.0-SNAPSHOT.423.
tests/smoke-test/src/main/kotlin/io/spine/logging/TapJavaLogging.kt KDoc wording adjustment.
tests/smoke-test/src/main/kotlin/io/spine/logging/MemoizingHandler.kt KDoc wording adjustment.
tests/smoke-test/src/main/kotlin/io/spine/logging/AbstractLoggingSmokeTest.kt KDoc wording adjustments.
tests/smoke-test/README.md README prose tweak.
tests/jvm-log4j2-backend-std-context/src/test/kotlin/LogLevelMapITest.kt Test KDoc wording adjustment.
tests/jvm-log4j2-backend-std-context/build.gradle.kts Dependency-comment wording adjustments.
tests/jvm-jul-backend-std-context/build.gradle.kts Dependency-comment wording adjustments.
tests/fixtures/src/commonMain/kotlin/io/spine/logging/context/BaseLogLevelMapTest.kt Comment wording adjustments.
tests/fixtures/src/commonMain/kotlin/io/spine/logging/context/AbstractLogLevelMapTest.kt KDoc wording adjustment.
README.md Top-level README prose tweaks.
platforms/jvm-default-platform/src/main/kotlin/io/spine/logging/backend/system/SystemClock.kt KDoc hyphenation tweak.
logging/src/jvmTest/kotlin/io/spine/logging/JvmLoggerSpec.kt Comment wording adjustments.
logging/src/jvmTest/kotlin/io/spine/logging/CountingRateLimiterSpec.kt Comment wording adjustment.
logging/src/jvmMain/kotlin/io/spine/logging/LogSiteStackTrace.kt KDoc wording adjustment.
logging/src/jvmMain/kotlin/io/spine/logging/LoggingDomainClassValue.kt Comment/KDoc wording adjustments.
logging/src/jvmMain/kotlin/io/spine/logging/LevelExts.kt KDoc wording adjustments.
logging/src/commonTest/kotlin/io/spine/logging/backend/MetadataProcessorSpec.kt Comment wording/hyphenation adjustments.
logging/src/commonTest/kotlin/io/spine/logging/backend/KeyValueFormatterSpec.kt Comment wording adjustments.
logging/src/commonTest/kotlin/io/spine/logging/backend/given/MetadataAssertions.kt KDoc punctuation adjustment.
logging/src/commonTest/kotlin/io/spine/logging/backend/given/FakeLogData.kt Typo fix in KDoc.
logging/src/commonTest/kotlin/io/spine/logging/AbstractLoggerSpec.kt Comment hyphenation/article fixes.
logging/src/commonMain/kotlin/io/spine/logging/WithLogging.kt KDoc article tweak.
logging/src/commonMain/kotlin/io/spine/logging/WeakRef.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/util/RecursionDepth.kt KDoc punctuation/wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/util/Checks.kt KDoc hyphenation tweak.
logging/src/commonMain/kotlin/io/spine/logging/StackSize.kt KDoc wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/RateLimitStatus.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/MutableMetadata.kt Comment punctuation tweak.
logging/src/commonMain/kotlin/io/spine/logging/MetadataKey.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/LogSiteStackTrace.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/LogSite.kt KDoc wording/typo fix.
logging/src/commonMain/kotlin/io/spine/logging/LogPerBucketingStrategy.kt KDoc wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/LoggingScopeProvider.kt KDoc spelling/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/LoggingScope.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/LoggingFactory.kt KDoc hyphenation tweak.
logging/src/commonMain/kotlin/io/spine/logging/LoggingDomain.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/LoggingApi.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/LogContext.kt KDoc wording/typo fixes.
logging/src/commonMain/kotlin/io/spine/logging/Level.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/KeyValueHandler.kt KDoc typo fix.
logging/src/commonMain/kotlin/io/spine/logging/KeyPart.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/InjectedLogSite.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/Tags.kt KDoc/comment typo fixes and wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/SegmentTrie.kt KDoc/comment wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/ScopeType.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/context/ScopedLoggingContexts.kt KDoc link/wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/ScopedLoggingContext.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/NoOpContextDataProvider.kt Comment punctuation tweak.
logging/src/commonMain/kotlin/io/spine/logging/context/LogLevelMap.kt KDoc wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/ContextMetadata.kt KDoc link/wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/context/ContextDataProvider.kt KDoc wording fixes.
logging/src/commonMain/kotlin/io/spine/logging/backend/SimpleMessageFormatter.kt KDoc wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/backend/Platform.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/backend/MetadataProcessor.kt KDoc wording/hyphenation/typo fixes.
logging/src/commonMain/kotlin/io/spine/logging/backend/MetadataKeyValueHandlers.kt KDoc wording/typo fix.
logging/src/commonMain/kotlin/io/spine/logging/backend/MetadataHandler.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/backend/Metadata.kt KDoc wording tweaks (and doc-reference fix requested in review comments).
logging/src/commonMain/kotlin/io/spine/logging/backend/LogMessageFormatter.kt Comment hyphenation tweak.
logging/src/commonMain/kotlin/io/spine/logging/backend/LoggingException.kt KDoc wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/backend/LoggerBackend.kt KDoc wording/typo fixes.
logging/src/commonMain/kotlin/io/spine/logging/backend/LogData.kt KDoc wording tweaks.
logging/src/commonMain/kotlin/io/spine/logging/backend/LogCallerFinder.kt KDoc wording/hyphenation tweaks.
logging/src/commonMain/kotlin/io/spine/logging/backend/KeyValueFormatter.kt KDoc punctuation/wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/backend/Clock.kt KDoc hyphenation/wording tweak.
logging/src/commonMain/kotlin/io/spine/logging/backend/BackendFactory.kt KDoc hyphenation tweak.
logging/src/commonMain/kotlin/io/spine/logging/AbstractLogger.kt KDoc wording tweak.
logging-testlib/src/jvmMain/kotlin/io/spine/logging/testing/TapConsole.kt KDoc wording tweaks.
logging-testlib/src/jvmMain/kotlin/io/spine/logging/testing/Log4j2Recorder.kt Comment typo fix + KDoc wording tweak.
docs/dependencies/pom.xml Regenerated dependency report (version + dependency versions).
CONTRIBUTING.md Prose tweaks (config-distributed doc).
contexts/std-context/src/main/kotlin/io/spine/logging/context/std/StdContextDataProvider.kt KDoc wording tweak.
contexts/std-context/src/main/kotlin/io/spine/logging/context/std/ScopedReference.kt KDoc punctuation tweak.
contexts/context-tests/src/testFixtures/kotlin/io/spine/logging/context/AbstractContextDataProviderSpec.kt KDoc wording tweak.
buildSrc/src/main/resources/dokka/styles/custom-styles.css Config refresh (copyright year).
buildSrc/src/main/kotlin/write-manifest.gradle.kts Comment wording tweaks.
buildSrc/src/main/kotlin/uber-jar-module.gradle.kts Build-logic refactor + typo fix (“fat jar”).
buildSrc/src/main/kotlin/test-module.gradle.kts Config refresh (copyright year).
buildSrc/src/main/kotlin/Strings.kt KDoc wording tweak.
buildSrc/src/main/kotlin/pmd-settings.gradle.kts Config refresh (copyright year).
buildSrc/src/main/kotlin/module.gradle.kts Comment wording tweak.
buildSrc/src/main/kotlin/module-testing.gradle.kts Comment wording tweak.
buildSrc/src/main/kotlin/kmp-publish.gradle.kts Config refresh (copyright year).
buildSrc/src/main/kotlin/kmp-module.gradle.kts Comment wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/testing/TestKitCoverage.kt Switch to shared JaCoCo agent coordinate constant.
buildSrc/src/main/kotlin/io/spine/gradle/testing/SpineCompilerCoverage.kt New build helper for collecting compiler-fork coverage.
buildSrc/src/main/kotlin/io/spine/gradle/testing/Multiproject.kt Comment typo fix (“dependent”).
buildSrc/src/main/kotlin/io/spine/gradle/testing/Logging.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/TaskName.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/StringExtensions.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/RunGradle.kt Comment wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/RunBuild.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/SpineLicense.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/ProjectMetadata.kt Build-logic refactor for non-empty project metadata extraction.
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/PomXmlWriter.kt Comment formatting tweak.
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/PomFormatting.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/ModuleDependency.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/MarkupExtensions.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/InceptionYear.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/pom/DependencyScope.kt Comment punctuation tweak.
buildSrc/src/main/kotlin/io/spine/gradle/report/license/Template.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/license/Tasks.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/report/license/ProjectDependencies.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/license/MarkdownReportRenderer.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/license/Configuration.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/report/coverage/SiblingCoverage.kt Make coverage consumer predicate visible for reuse.
buildSrc/src/main/kotlin/io/spine/gradle/report/coverage/KoverConfig.kt Feed additional exec data into root Kover aggregation; Gradle API update.
buildSrc/src/main/kotlin/io/spine/gradle/repo/RepoSlug.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/repo/Credentials.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/publish/StandardJavaPublicationHandler.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/publish/SpinePublishing.kt Comment wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/publish/PublishingRepos.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/publish/PublishingExts.kt Comment wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/publish/PublicationHandler.kt KDoc punctuation tweak.
buildSrc/src/main/kotlin/io/spine/gradle/publish/ProtoExts.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/publish/CloudRepo.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/publish/CloudArtifactRegistry.kt Comment wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/ProjectExtensions.kt KDoc article tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/task/Publish.kt Typo fix (“NPM”).
buildSrc/src/main/kotlin/io/spine/gradle/javascript/task/IntegrationTest.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/plugin/Protobuf.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/plugin/McJs.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/plugin/JsPlugins.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/plugin/Idea.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/JsExtension.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/JsEnvironment.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javascript/JsContext.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/javadoc/JavadocTag.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/javadoc/JavadocConfig.kt KDoc wording tweaks + formatting.
buildSrc/src/main/kotlin/io/spine/gradle/javadoc/ExcludeInternalDoclet.kt KDoc hyphenation tweak.
buildSrc/src/main/kotlin/io/spine/gradle/javadoc/Encoding.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/javac/Javac.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/javac/ErrorProne.kt KDoc hyphenation tweak.
buildSrc/src/main/kotlin/io/spine/gradle/java/Tasks.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/github/pages/UpdateGitHubPagesExtension.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/github/pages/UpdateGitHubPages.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/github/pages/Update.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/github/pages/AuthorEmail.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/git/UserInfo.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt Comment wording/typo fixes (“temporary”, “check out”, etc.).
buildSrc/src/main/kotlin/io/spine/gradle/git/Branch.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/dart/task/Publish.kt Comment wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/dart/task/IntegrationTest.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/dart/task/DartTasks.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/dart/task/Build.kt KDoc wording tweaks + typo fix (“compatibility”).
buildSrc/src/main/kotlin/io/spine/gradle/dart/plugin/Protobuf.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/dart/plugin/DartPlugins.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/dart/DartExtension.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/io/spine/gradle/dart/DartEnvironment.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/dart/DartContext.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/gradle/ConfigTester.kt Comment wording tweaks + punctuation.
buildSrc/src/main/kotlin/io/spine/gradle/Clean.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/checkstyle/CheckStyleConfig.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/Build.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/gradle/base/Tasks.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/docs/MarkdownDocument.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/TestKitTruth.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/SystemLambda.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/OpenTest4J.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/Kover.kt Kover version bump.
buildSrc/src/main/kotlin/io/spine/dependency/test/Kotest.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/Jacoco.kt Add Jacoco.agent coordinate constant.
buildSrc/src/main/kotlin/io/spine/dependency/test/Hamcrest.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/test/AssertK.kt KDoc punctuation tweak.
buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/local/ToolBase.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/local/Time.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/local/TestLib.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/Spine.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/Reflect.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/ProtoTap.kt Comment wording tweak.
buildSrc/src/main/kotlin/io/spine/dependency/local/ModelCompiler.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/Logging.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvm.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/local/Compiler.kt Fallback versions bump + KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/dependency/local/Change.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/BaseTypes.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/local/Base.kt Local dependency version bump.
buildSrc/src/main/kotlin/io/spine/dependency/lib/Slf4J.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/dependency/lib/Roaster.kt KDoc typo fix (“built”).
buildSrc/src/main/kotlin/io/spine/dependency/lib/Protobuf.kt KDoc wording tweak.
buildSrc/src/main/kotlin/io/spine/dependency/lib/KotlinX.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/Klaxon.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/JavaX.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/JavaPoet.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/JavaJwt.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/Jackson.kt Jackson version bump.
buildSrc/src/main/kotlin/io/spine/dependency/lib/Coroutines.kt KDoc typo fix (“project”).
buildSrc/src/main/kotlin/io/spine/dependency/lib/BouncyCastle.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/Asm.kt Comment wording tweak.
buildSrc/src/main/kotlin/io/spine/dependency/lib/AppEngine.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/lib/ApacheHttp.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/kotlinx/Serialization.kt KDoc spacing tweak.
buildSrc/src/main/kotlin/io/spine/dependency/kotlinx/KotlinX.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/io/spine/dependency/Dependency.kt KDoc spacing tweak.
buildSrc/src/main/kotlin/io/spine/dependency/build/ErrorProne.kt Error Prone version bump + compatibility note.
buildSrc/src/main/kotlin/io/spine/dependency/boms/BomsPlugin.kt Comment typo fix (“though”).
buildSrc/src/main/kotlin/io/spine/dependency/boms/Boms.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/DokkaExts.kt KDoc wording tweaks.
buildSrc/src/main/kotlin/DocumentationSettings.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/detekt-code-analysis.gradle.kts KDoc wording tweaks.
buildSrc/src/main/kotlin/DependencyResolution.kt Comment hyphenation tweak.
buildSrc/src/main/kotlin/config-tester.gradle.kts Comment wording tweak.
buildSrc/src/main/kotlin/BuildSettings.kt Config refresh (copyright year).
buildSrc/src/main/kotlin/BuildExtensions.kt KDoc wording tweaks + typo fix.
buildSrc/settings.gradle.kts Config refresh (copyright year).
buildSrc/quality/checkstyle.xml Config refresh (copyright year).
buildSrc/quality/checkstyle-suppressions.xml Config refresh (copyright year).
buildSrc/build.gradle.kts Kover version bump + comment wording tweaks.
backends/probe-backend/src/main/kotlin/io/spine/logging/backend/probe/TypedBackendFactory.kt KDoc wording tweak.
backends/probe-backend/src/main/kotlin/io/spine/logging/backend/probe/DynamicBackendFactoryService.kt KDoc wording tweak.
backends/probe-backend/src/main/kotlin/io/spine/logging/backend/probe/DynamicBackendFactory.kt KDoc wording tweak.
backends/probe-backend/src/main/kotlin/io/spine/logging/backend/probe/CaptureLogData.kt KDoc wording tweak.
backends/probe-backend/README.md README wording tweak (“at runtime”).
backends/log4j2-backend/src/test/kotlin/io/spine/logging/backend/log4j2/given/StubLogData.kt Typo fix in KDoc.
backends/log4j2-backend/src/main/kotlin/io/spine/logging/backend/log4j2/ValueQueue.kt Comment/KDoc wording tweaks.
backends/jul-backend/src/test/kotlin/io/spine/logging/backend/jul/given/StubLogData.kt Typo fix in KDoc.
backends/jul-backend/src/main/kotlin/io/spine/logging/backend/jul/JulBackendFactory.kt KDoc wording tweak.
backends/jul-backend/src/main/kotlin/io/spine/logging/backend/jul/JulBackend.kt Comment/KDoc wording tweaks.
backends/jul-backend/src/main/kotlin/io/spine/logging/backend/jul/AbstractJulRecord.kt KDoc wording tweaks.
backends/jul-backend/src/main/kotlin/io/spine/logging/backend/jul/AbstractJulBackend.kt Comment typo fix + wording tweaks.
.idea/misc.xml Remove tracked IntelliJ project file.
.idea/live-templates/README.md README spacing tweak.
.gitignore Ignore .idea/misc.xml and add Claude-related ignores.
.claude/settings.json Claude settings update (plans directory + permissions).
.agents/tasks/otel-backend-report.md Minor typo fix in task doc.
.agents/project-overview.md Remove outdated duplicated doc.
.agents/java-kotlin-conversion.md Remove outdated duplicated doc.
Files not reviewed (1)
  • .idea/misc.xml: Generated file
Comments suppressed due to low confidence (1)

logging/src/commonMain/kotlin/io/spine/logging/backend/Metadata.kt:79

  • KDoc references getCount() in the @throws description, but this type exposes size() (and has no getCount()), which makes the documentation inaccurate.

Comment thread logging/src/commonMain/kotlin/io/spine/logging/backend/Metadata.kt Outdated
Comment thread logging/src/jvmMain/kotlin/io/spine/logging/LevelExts.kt
@alexander-yevsyukov @claude
Fix incorrect KDoc references flagged in review
619ae7a 
Two documentation-correctness fixes from Copilot review of PR #148:

- `Metadata.getKey`/`getValue` `@throws` referenced `getCount()`, which does
  not exist on the type; the method is `size()`.
- `LevelExts` described `ConvertedLevel` as a "converting" instance, but it
  represents a *converted* level and performs no conversion itself.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@alexander-yevsyukov alexander-yevsyukov self-assigned this Jul 23, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to 🏗 In progress in v2.0 Jul 23, 2026
@alexander-yevsyukov alexander-yevsyukov moved this from 🏗 In progress to In Review in v2.0 Jul 23, 2026
@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.80%. Comparing base (b883c8f) to head (619ae7a).

Additional details and impacted files 
@@            Coverage Diff            @@
##             master     #148   +/-   ##
=========================================
  Coverage     67.80%   67.80%           
  Complexity      464      464           
=========================================
  Files           109      109           
  Lines          2578     2578           
  Branches        403      403           
=========================================
  Hits           1748     1748           
  Misses          696      696           
  Partials        134      134
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@alexander-yevsyukov
alexander-yevsyukov merged commit 584faa2 into master Jul 24, 2026
10 checks passed
@alexander-yevsyukov
alexander-yevsyukov deleted the proofread-etc branch July 24, 2026 09:43
@github-project-automation github-project-automation Bot moved this from In Review to ✅ Done in v2.0 Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments
@armiol armiol armiol approved these changes

Assignees

@alexander-yevsyukov alexander-yevsyukov

Labels

None yet

Projects

v2.0
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@alexander-yevsyukov @armiol