Docs set 1 #261
Docs set 1 #261
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation by replacing informal "Please note" phrases with more concise "Note that" phrasing, and bumps version numbers across multiple configuration files and documentation.
Changes:
- Simplified documentation language by removing "Please" prefix from note statements
- Updated version from 2.0.0-SNAPSHOT.393 to 2.0.0-SNAPSHOT.394 across configuration files
- Updated dependency versions (CoreJvmCompiler from .050 to .051, validation-jvm-runtime from .392 to .393)
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| version.gradle.kts | Bumped validation version to .394 |
| tests/consumer/src/test/kotlin/io/spine/validation/test/CurrencyOptionITest.kt | Removed "Please" from documentation note |
| pom.xml | Updated project version to .394 and dependency versions |
| jvm-runtime/src/main/kotlin/io/spine/validation/MessageValidator.kt | Simplified "Please note" to "Note" in KDoc |
| java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceEnumField.kt | Condensed and simplified documentation note |
| java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceBytesField.kt | Condensed and simplified documentation note |
| java/src/main/kotlin/io/spine/tools/validation/java/JavaValidationPlugin.kt | Reformatted multi-line KDoc note for clarity |
| docs/01-getting-started/index.md | Improved line wrapping for better readability |
| dependencies.md | Updated version references and generation timestamps |
| config | Updated subproject commit reference |
| buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt | Updated validation version constant to .393 |
| buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt | Updated CoreJvmCompiler versions to .051 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Also: * Update the reference to Jakarta Validation, addressing the recent name change.
Also: * Update Kotlin requirement to 2.2.21+.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
docs/options.proto:1
- Corrected spelling of 'please' to 'use' for consistency with the PR's goal of removing informal language like 'Please' from comments.
/*
docs/ToC.md:1
- These link text entries still use title case capitalization ("First Validated Model", "Validation Workflow") while other entries in the same file have been updated to sentence case. These should be changed to "Your first validated model" and "Validation workflow" for consistency.
# Spine Validation — Table of contents
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## What’s Next | ||
| ## What's next | ||
|
|
||
| - [Target Audience](target-audience.md) |
There was a problem hiding this comment.
The link text "Target Audience" uses title case, but the PR has changed the target file's heading to sentence case "Target audience". The link text should match for consistency.
| - [Target Audience](target-audience.md) | |
| - [Target audience](target-audience.md) |
They will be described separately and later. Probably, it's going to be a part of the documentation of the Spine Time library.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 32 out of 32 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import org.junit.jupiter.api.assertThrows | ||
| import org.junit.jupiter.api.Assertions.assertDoesNotThrow | ||
|
|
||
| @DisplayName("`BankCard`in Kotlin should") |
There was a problem hiding this comment.
Missing space between backtick and "in". Should be "BankCard in Kotlin should".
| @DisplayName("`BankCard`in Kotlin should") | |
| @DisplayName("`BankCard` in Kotlin should") |
| // Must be present and contain at least 4 Latin letters or spaces. | ||
| string owner = 2 [ | ||
| (required) = true, | ||
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$" |
There was a problem hiding this comment.
The regex pattern differs from the one shown in the documentation file docs/01-getting-started/first-model.md (line 38), which has [a-z] at the end instead of [A-Za-z]. The patterns should match between the actual proto file and the documentation example.
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$" | |
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$" |
| // Must be present and contain at least 4 Latin letters or spaces. | ||
| string owner = 2 [ | ||
| (required) = true, | ||
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$" |
There was a problem hiding this comment.
The regex pattern in this documentation differs from the actual pattern in the proto file docs/code/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto (line 26), which has [A-Za-z] at the end instead of [a-z]. The patterns should match between the documentation and the actual proto file.
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$" | |
| (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$" |
No description provided.