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

[hotfix][docs] Makes the japicmp script documentation more consistent after the change in cb442936. #21188

Merged
merged 1 commit into from
Oct 31, 2022

Conversation

XComp
Copy link
Contributor

@XComp XComp commented Oct 28, 2022

What is the purpose of the change

PR #21184 updated the documentation a bit leaving it in a kind of inconsistent state. This hotfix PR fixes this issue. Reading the previous version of the comment was confusing because of the snapshot version being used for specifying the reference version but also for refering to the snapshot branch. I tried to make this more explicit now with that PR.

Brief change log

  • Updates docs in script

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

@XComp XComp requested a review from zentol October 28, 2022 12:17
@flinkbot
Copy link
Collaborator

flinkbot commented Oct 28, 2022

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@XComp
Copy link
Contributor Author

XComp commented Oct 31, 2022

Thanks, @zentol . The build failure is due to FLINK-24119. I'm merging without rerunning it because it's just docs update.

@XComp XComp merged commit c2a76f7 into apache:master Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants