Skip to content
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

Fix javadoc references, links and spaces. #3768

Merged
merged 7 commits into from
May 17, 2023

Conversation

arturobernalg
Copy link
Contributor

Impact

  • Bug fix (non-breaking change which fixes expected existing functionality)
  • [ X] Enhancement/New feature (adds functionality without impacting existing logic)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

@nvoxland
Copy link
Contributor

nvoxland commented Feb 6, 2023

Initial/Pre-Review Thoughts

Thanks for the fix. A quick scan looks right, but need someone to double check there isn't any unexpected changes to the javadocs

Questions I have:

  • None

Potential risks:

  • None

What could make the full review difficult:

  • Nothing

@MalloD12 MalloD12 self-requested a review April 3, 2023 19:18
@MalloD12 MalloD12 self-assigned this Apr 3, 2023
Copy link
Collaborator

@MalloD12 MalloD12 left a comment

Choose a reason for hiding this comment

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

Approved

Review and testing results:

PR changes looks good to me. Minor corrections (extra parenthesis removed from javadoc). Build and tests executed successfully (Functional tests failing at the moment, but that is not related with changes made here).

Things to be aware of:

  • None

Things to worry about:

  • None

@XDelphiGrl
Copy link
Contributor

Functional tests running here: https://github.com/liquibase/liquibase-pro-tests/actions/runs/4928321834
Test Harness running here: [https://github.com/liquibase/liquibase-test-harness/actions/runs/4928326159]

@@ -5,7 +5,7 @@

/**
* This interface defines how objects can be extended with additional attributes at runtime without subclassing and exposes the ability to query attributes without resorting to reflection.
*
* <p>
Copy link
Contributor

Choose a reason for hiding this comment

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

For those who were unaware, as I was prior to this review, the parser infers the closing </p>. :)

Copy link
Contributor

@XDelphiGrl XDelphiGrl left a comment

Choose a reason for hiding this comment

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

Do you like cleaner JavaDoc output, with correctly formatted URLs and clean spacing between paragraphs? You're in luck! This PR provides just that, with the addition of fixing two places in the documentation where the incorrect variable name was referenced in the JavaDoc annotations.

  • Functional and test harness executions passing.
  • No additional testing required.

APPROVED

# Conflicts:
#	liquibase-standard/src/main/java/liquibase/hub/HubServiceFactory.java
@filipelautert filipelautert merged commit c6be89d into liquibase:master May 17, 2023
@filipelautert filipelautert added this to the 1NEXT milestone May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants