Proofread comments and documentation

[alexander-yevsyukov]

Summary

Repo-wide English proofread of base-libraries — grammar, spelling, punctuation,
articles, restrictive which/that, verb forms in API summaries, and verb
complementation (allow/enable + gerund) — across KDoc, Javadoc, Protobuf doc
comments, and Markdown.

Prose only: no executable code, identifiers, string literals, or doc-link
targets were changed.

Commits

• Bump version 2.0.0-SNAPSHOT.425 → .426 — required by the versioning policy.
• Update dependency reports — docs/dependencies/ regenerated for the new
  version; the report diff is version-only (no dependency changes).
• Proofread comments and documentation — 103 files of comment/doc prose fixes.

Representative fixes

filed → field, withing → within, paramater → parameter,
restiction → restriction, weather → whether, cased by → caused by,
not tested → not nested (matching check(isNested)), allows to X →
allows X-ing, restrictive which → that, and many missing articles.

Verification

• ./gradlew clean build dokkaGenerate passes — compile, tests, and Dokka/KDoc
  link checks are all green.
• Reviewed with the repository's own reviewers (review-docs, spine-code-review,
  kotlin-engineer). All three independently flagged one shared regression — an
  automated trailing-whitespace pass had stripped load-bearing whitespace from a
  StringsSpec test fixture — which is fixed in this PR.

[Copilot]

Pull request overview

Repo-wide documentation/comment proofreading sweep, plus the required snapshot version bump and regenerated dependency reports, keeping changes strictly in prose (no executable logic or identifiers adjusted).

Changes:

• Bumped published snapshot version 2.0.0-SNAPSHOT.425 → .426.
• Regenerated docs/dependencies/ reports for the new version (version/timestamp-only diffs).
• Proofread and standardized English in KDoc/Javadoc/Proto comments across multiple modules (articles, verb forms, punctuation, etc.).

Reviewed changes

Copilot reviewed 106 out of 106 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
version.gradle.kts	Bumps versionToPublish snapshot number.
format/src/test/kotlin/io/spine/format/FormatTest.kt	KDoc proofreading for the format test base class.
format/src/main/kotlin/io/spine/format/write/JacksonWriter.kt	KDoc proofreading for Jackson-based writer base class.
format/src/main/kotlin/io/spine/format/Parse.kt	KDoc proofreading in parse(..) API docs.
environment/src/test/java/io/spine/environment/given/AppEngineStandard.java	Javadoc typo fix + license header URL normalization.
environment/src/main/java/io/spine/environment/Tests.java	Javadoc wording tweak + license header URL normalization.
environment/src/main/java/io/spine/environment/EnvironmentType.java	Javadoc wording tweak + license header URL normalization.
environment/src/main/java/io/spine/environment/Environment.java	Javadoc wording tweaks for clarity/grammar.
environment/src/main/java/io/spine/environment/CustomEnvironmentType.java	Javadoc wording tweak.
docs/dependencies/pom.xml	Updates reported version to .426.
docs/dependencies/dependencies.md	Updates report headers and generation timestamp for .426.
base/src/test/proto/spine/test/type/types.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/protobuf/descriptor_exts_spec.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/test_uuid_messages.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/test_rejections.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/test_events.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/test_entity_states.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/test_commands.proto	Proto doc comment proofreading + formatting tweak.
base/src/test/proto/spine/test/code/proto/column_option_test.proto	Proto doc comment proofreading.
base/src/test/kotlin/io/spine/string/StringsSpec.kt	Test comment proofreading (whitespace-related fixture note).
base/src/test/kotlin/io/spine/LoggingSmokeTest.kt	KDoc proofreading in smoke test.
base/src/test/kotlin/io/spine/code/java/ClassNameSpec.kt	Test KDoc typo fix (“Stub”).
base/src/test/java/io/spine/string/TimestampStringifierTest.java	Test comment proofreading.
base/src/test/java/io/spine/query/QueryPredicateTest.java	Test Javadoc grammar fix.
base/src/test/java/io/spine/query/given/RecordQueryBuilderTestEnv.java	Test Javadoc typo fix (“parameter”).
base/src/test/java/io/spine/protobuf/TypeConverterTest.java	Test comment proofreading.
base/src/test/java/io/spine/protobuf/GoogleTypesTest.kt	Test comment proofreading.
base/src/test/java/io/spine/protobuf/AnyPackerTest.java	Test Javadoc proofreading.
base/src/test/java/io/spine/code/proto/given/package-info.java	Package doc proofreading.
base/src/test/java/io/spine/base/RejectionThrowableTest.java	Test Javadoc proofreading.
base/src/test/java/io/spine/base/IdentifierTest.java	Test comment typo fix (“brevity”).
base/src/test/java/io/spine/base/given/GivenDurations.java	Test environment comment proofreading.
base/src/test/java/io/spine/base/given/ConstantTimeProvider.java	Javadoc proofreading.
base/src/main/proto/spine/options.proto	Extensive proto option docs proofreading/consistency edits.
base/src/main/proto/spine/base/field_path.proto	Proto doc comment proofreading + formatting tweak.
base/src/main/kotlin/io/spine/type/ProtoTextExts.kt	KDoc typo fix (“two spaces”).
base/src/main/kotlin/io/spine/string/Strings.kt	KDoc proofreading in string utilities.
base/src/main/kotlin/io/spine/string/Stringify.kt	KDoc proofreading in stringifier utilities.
base/src/main/kotlin/io/spine/string/Indent.kt	KDoc proofreading in indentation utility.
base/src/main/kotlin/io/spine/string/CharSequenceExts.kt	KDoc typo fix (“text”).
base/src/main/kotlin/io/spine/security/InvocationGuard.kt	KDoc typo fix (“if”).
base/src/main/kotlin/io/spine/protobuf/ProtoConverter.kt	KDoc proofreading (“the supplied”).
base/src/main/kotlin/io/spine/protobuf/MessageExts.kt	Block comment proofreading.
base/src/main/kotlin/io/spine/protobuf/DescriptorExts.kt	KDoc proofreading (“the Protobuf API”).
base/src/main/kotlin/io/spine/io/Ensure.kt	KDoc article fix (“an existing”).
base/src/main/kotlin/io/spine/io/Delete.kt	KDoc wording tweak (“the JVM”).
base/src/main/kotlin/io/spine/compare/ProtoComparators.kt	KDoc article fix (“the”).
base/src/main/kotlin/io/spine/code/proto/FieldDescriptorProtoExts.kt	KDoc punctuation fix.
base/src/main/kotlin/io/spine/code/proto/DescriptorSetReferenceFile.kt	KDoc verb agreement fix.
base/src/main/kotlin/io/spine/base/ThrowableExts.kt	KDoc typo fix (“caused”).
base/src/main/kotlin/io/spine/base/FieldPathExts.kt	KDoc typo fix (“nested”).
base/src/main/kotlin/io/spine/base/EntityState.kt	KDoc punctuation fix.
base/src/main/java/io/spine/value/StringTypeValue.java	Javadoc grammar fix (“if”).
base/src/main/java/io/spine/type/UnexpectedTypeException.java	Javadoc grammar fix (“instance of”).
base/src/main/java/io/spine/type/TypeUrl.java	Javadoc proofreading (“types”, “the string representation”).
base/src/main/java/io/spine/type/TypeName.java	Javadoc verb agreement fix.
base/src/main/java/io/spine/type/Type.java	Javadoc article/clarity fixes.
base/src/main/java/io/spine/type/MessageType.java	Javadoc proofreading (articles/typos).
base/src/main/java/io/spine/type/KnownTypes.java	Javadoc grammar fix (“known to”).
base/src/main/java/io/spine/type/EnumType.java	Comment hyphenation fix (“top-level”).
base/src/main/java/io/spine/string/Stringifier.java	Javadoc verb agreement fixes.
base/src/main/java/io/spine/query/Subject.java	Javadoc article fixes.
base/src/main/java/io/spine/query/SortBy.java	Javadoc article fix (“a sorting”).
base/src/main/java/io/spine/query/RecordQueryBuilder.java	Javadoc grammar fix (“wish”).
base/src/main/java/io/spine/query/RecordColumns.java	Javadoc wording tweaks for clarity.
base/src/main/java/io/spine/query/QueryCriterion.java	Javadoc typo/grammar fixes.
base/src/main/java/io/spine/query/QueryBuilder.java	Javadoc article fix.
base/src/main/java/io/spine/query/Query.java	Javadoc article fix.
base/src/main/java/io/spine/query/package-info.java	Package docs proofreading (grammar/punctuation).
base/src/main/java/io/spine/query/IdParameter.java	Javadoc article fix.
base/src/main/java/io/spine/query/Expression.java	Javadoc wording tweaks.
base/src/main/java/io/spine/query/EntityQueryBuilder.java	Javadoc article/grammar fixes.
base/src/main/java/io/spine/query/EntityCriterion.java	Javadoc article fix.
base/src/main/java/io/spine/query/Distribution.java	Javadoc wording + whitespace cleanup.
base/src/main/java/io/spine/query/CustomCriterion.java	Javadoc wording tweak.
base/src/main/java/io/spine/query/CartesianProducts.java	Javadoc wording tweaks.
base/src/main/java/io/spine/protobuf/WrappingConverter.java	Javadoc typo fix (“than”).
base/src/main/java/io/spine/protobuf/TypeConverter.java	Javadoc wording fixes.
base/src/main/java/io/spine/protobuf/PrimitiveConverter.java	Javadoc typo fix (“convert”).
base/src/main/java/io/spine/protobuf/package-info.java	Package doc wording tweak.
base/src/main/java/io/spine/protobuf/Durations2.java	Javadoc grammar tweaks.
base/src/main/java/io/spine/protobuf/AnyPacker.java	Javadoc wording tweaks (one remaining grammar issue noted in review comment).
base/src/main/java/io/spine/option/BaseOptionsProvider.java	Javadoc verb agreement fix.
base/src/main/java/io/spine/io/ResourceObject.java	Javadoc wording tweak (“at runtime”).
base/src/main/java/io/spine/code/proto/SourceFile.java	Javadoc article fix.
base/src/main/java/io/spine/code/proto/ScalarType.java	Javadoc typo fix.
base/src/main/java/io/spine/code/proto/PackageName.java	Javadoc article fix.
base/src/main/java/io/spine/code/proto/LocationPath.java	Javadoc article fix.
base/src/main/java/io/spine/code/proto/FileSet.java	Javadoc article/grammar tweaks.
base/src/main/java/io/spine/code/proto/FieldName.java	Javadoc article fix.
base/src/main/java/io/spine/code/proto/FieldDeclaration.java	Javadoc grammar tweaks.
base/src/main/java/io/spine/code/proto/EntityStateOption.java	Javadoc typo fix (“kinds”).
base/src/main/java/io/spine/code/proto/ColumnOption.java	Javadoc article/line-wrap tweak.
base/src/main/java/io/spine/code/java/PackageName.java	Javadoc article fix.
base/src/main/java/io/spine/code/java/ClassName.java	Javadoc typos/hyphenation fixes.
base/src/main/java/io/spine/base/Time.java	Javadoc grammar tweaks.
base/src/main/java/io/spine/base/RejectionThrowable.java	Javadoc article fix.
base/src/main/java/io/spine/base/IdType.java	Javadoc singular/plural fix.
base/src/main/java/io/spine/base/Identifier.java	Comment grammar tweaks.
base/src/main/java/io/spine/base/Field.java	Javadoc/comment typo fix (“field”).
base/src/main/java/io/spine/base/Errors.java	Javadoc article fix.
base/build.gradle.kts	Comment-only proofreading in build script.
annotations/src/main/kotlin/io/spine/annotation/GeneratedMixin.kt	KDoc proofreading (articles/typos).
.agents/tasks/archive/raise-base-coverage.md	Config-managed agent task doc: prose-only update (not reviewed).
.agents/tasks/add-suppliers2-iterators2.md	Config-managed agent task doc: prose-only update (not reviewed).
.agents/memory/reference/cache-warm-window.md	Config-managed agent memory doc: prose-only update (not reviewed).

[Copilot]

Pull request overview

Copilot reviewed 106 out of 106 changed files in this pull request and generated 3 comments.