Docs set 1 #261
Draft
Docs set 1 #261
Conversation
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
Contributor
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.