Skip to content

Fix UuidPatternConverter javadoc/adoc #3768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: 2.x
Choose a base branch
from

Conversation

julianladisch
Copy link

@julianladisch julianladisch commented Jun 20, 2025

Remove javadoc incorrectly copied from SequencePatternConverter.

Add javadoc for UuidPatternConverter based on the pattern-layout.adoc manual page.

Add details to the UuidPatternConverter section in pattern-layout.adoc.

Checklist

Before we can review and merge your changes, please go through the checklist below. If you're still working on some items, feel free to submit your pull request as a draft—our CI will help guide you through the remaining steps.

✅ Required checks

  • License: I confirm that my changes are submitted under the Apache License, Version 2.0.

  • Commit signatures: All commits are signed and verifiable. (See GitHub Docs on Commit Signature Verification).

  • Code formatting: The code is formatted according to the project’s style guide.

    How to check and fix formatting
    • To check formatting: ./mvnw spotless:check
    • To fix formatting: ./mvnw spotless:apply

    See the build instructions for details.

  • Build & Test: I verified that the project builds and all unit tests pass.

    How to build the project

    Run: ./mvnw verify

    See the build instructions for details.

🧪 Tests (select one)

  • n/a: I have added or updated tests to cover my changes.
  • No additional tests are needed for this change.

📝 Changelog (select one)

  • n/a: I added a changelog entry in src/changelog/.2.x.x. (See Changelog Entry File Guide).
  • This is a trivial change and does not require a changelog entry.

Remove javadoc incorrectly copied from SequencePatternConverter.

Add javadoc for UuidPatternConverter based on the pattern-layout.adoc manual page.
Copy link
Member

@vy vy left a comment

Choose a reason for hiding this comment

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

@julianladisch, thanks so much for these valuable corrections! 💯
Would you also mind updating pattern-layout.adoc too, please?

@vy vy self-assigned this Jun 20, 2025
@vy vy added documentation Pull requests or issues that affect documentation waiting-for-user More information is needed from the user labels Jun 20, 2025
@vy vy added this to the 2.25.1 milestone Jun 20, 2025
@julianladisch julianladisch requested a review from vy June 20, 2025 14:29
@julianladisch julianladisch changed the title Fix UuidPatternConverter javadoc Fix UuidPatternConverter javadoc/adoc Jun 20, 2025
@ppkarwasz ppkarwasz modified the milestones: 2.25.1, 2.26.0 Jun 21, 2025
@vy vy removed the waiting-for-user More information is needed from the user label Jun 27, 2025
@vy vy modified the milestones: 2.26.0, 2.25.1 Jun 27, 2025
@vy vy enabled auto-merge (squash) June 27, 2025 07:17
@vy
Copy link
Member

vy commented Jun 27, 2025

@julianladisch, thanks so much for the kind help. It should be merged once CI passes.

Copy link

Job Requested goals Build Tool Version Build Outcome Build Scan®
build-macos-latest clean install 3.9.8 Build Scan PUBLISHED
build-ubuntu-latest clean install 3.9.8 Build Scan PUBLISHED
build-windows-latest clean install 3.9.8 Build Scan PUBLISHED
Generated by gradle/develocity-actions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests or issues that affect documentation
Projects
Status: To triage
Development

Successfully merging this pull request may close these issues.

3 participants